███████ ██████  ███   ███  ██    ████████ ██████   ███   ███  ██████ ██      ████  ████████ ██████
██      ██     ██ ██ ██ ██ ██       ██    ██      ██ ██ ██ ██ ██  ██ ██     ██  ██    ██    ██
███████ ██████ ██  ███  ██ ██       ██    █████   ██  ███  ██ ██████ ██     ██████    ██    ██████
     ██ ██     ██       ██ ██       ██    ██      ██       ██ ██     ██     ██  ██    ██    ██
███████ ██     ██       ██ ██████   ██    ██████  ██       ██ ██     ██████ ██  ██    ██    ██████

◎ A Base Project Setup for SFML/ImGui

SFML TEMPLATE

C++ Rendering/Graphics project template with SFML and Dear ImGUI.

Table of Contents

• 📍 Overview
• 👾 Features
• 📁 Project Structure
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
  • 🤖 Usage
  • 🧪 Testing
• 📌 Project Roadmap
• 🔰 Contributing
• 🙌 Acknowledgments
• 🎗 License

---

👾 Features

• Sources, headers and mains separated in distinct folders
• Use of modern CMake for much easier compiling
• Continuous integration via GitHub Actions

---

Dependencies

Libraries

Library	Purpose	Details
ImGui	Graphical User Interface	Immediate Mode Graphical User Interface
SFML	Graphic/Rendering Library	Used for Graphic Rendering

Compilers

Compiler	Platforms	Version
Clang C/C++ Compiler	Linux/Windows/MacOs	0
Microsoft compiler (MSVC)	Windows Only	0
GNU/MinGW Compiler	Linux/Windows/MacOs	0

Build Tools

• CMake

  Cmake Build Configuration/Compilation

• Makefile

  Makefile Build Configuration/Compilation

• Scripts

  Scripts Build Configuration/Compilation

Others

• Conan for install packages
• Git for cmake automatic dependencies
• Doxygen for generate documentation (optional)

---

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the SFMLTem project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone --recursive https://github.com/djoezeke/SFMLTem

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

🙌 Acknowledgments

References

• GLFW Template : with OpenGl and ImGui

• SDL Template : with SDL and ImGui

• Inspirational templates : CppProject, ModernCppStarter

More Reading

Here are some useful resources to learn more:

• Official CMake Tutorial

• Include ImGui with Conan

• Include ImGui with Vulkan

---

🎗 License

This project is protected under the MIT License. For more details, refer to the LICENSE file.

---