Skip to content

Commit eff74b3

Browse files
committed
Refactor project structure and update README
1 parent 5218ffc commit eff74b3

File tree

8 files changed

+1066
-19
lines changed

8 files changed

+1066
-19
lines changed
File renamed without changes.

.gitignore

Lines changed: 1045 additions & 4 deletions
Large diffs are not rendered by default.

.vscode/tasks.json

Whitespace-only changes.

CMakeLists.txt

Whitespace-only changes.

CMakePresets.json

Whitespace-only changes.

README.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@
2121
</p>
2222
<p align="center"><!-- default option, no dependency badges. -->
2323
</p>
24-
<p align="center">
25-
<!-- default option, no dependency badges. -->
26-
</p>
2724
<br>
2825

2926
<details><summary>Table of Contents</summary>
@@ -39,22 +36,23 @@
3936
- [📌 Project Roadmap](#-project-roadmap)
4037
- [🔰 Contributing](#-contributing)
4138
- [🙌 Acknowledgments](#-acknowledgments)
42-
- [🎗 License](#-license)
39+
- [📃 License](#-license)
4340

4441
</details>
4542

46-
---
43+
## 📍 Overview
4744

4845
## 👾 Features
4946

50-
5147
- Sources, headers and mains separated in distinct folders
5248
- Use of modern [CMake](https://cmake.org/) for much easier compiling
5349
- Continuous integration via [GitHub Actions](https://help.github.com/en/actions)
5450

5551
---
5652

57-
## Dependencies
53+
## 🚀 Getting Started
54+
55+
## ☑️ Prerequisites
5856

5957
### Libraries
6058

@@ -96,6 +94,7 @@
9694
</div>
9795

9896
### Build Tools
97+
9998
- [CMake](https://cmake.org/)
10099

101100
<details closed>
@@ -114,12 +113,19 @@
114113
<summary>Scripts Build Configuration/Compilation</summary>
115114
</details>
116115

117-
### Others
118-
* [Conan](https://conan.io/) for install packages
119-
* [Git](https://git-scm.com/) for cmake automatic dependencies
120-
* [Doxygen](https://doxygen.org/) for generate documentation (optional)
116+
### Others
121117

122-
---
118+
- [Conan](https://conan.io/) for install packages
119+
- [Git](https://git-scm.com/) for cmake automatic dependencies
120+
- [Doxygen](https://doxygen.org/) for generate documentation (optional)
121+
122+
## ⚙️ Installation
123+
124+
## 🤖 Usage
125+
126+
## 🧪 Testing
127+
128+
## 📌 Project Roadmap
123129

124130
## 🔰 Contributing
125131

@@ -168,7 +174,7 @@
168174

169175
### References
170176

171-
- [GLFW](https://github.com/djoezeke/GLFWTem/) Template : with [OpenGl]() and [ImGui](https://github.com/ocornut/imgui)
177+
- [GLFW](https://github.com/djoezeke/GLFWTem/) Template : with [OpenGl]() and [ImGui](https://github.com/ocornut/imgui)
172178
- [SDL](https://github.com/djoezeke/SDLTem/) Template : with [SDL](https://github.com/libsdl-org/sdl) and [ImGui](https://github.com/ocornut/imgui)
173179

174180
- Inspirational templates : [CppProject](https://github.com/tweether/cpp-project), [ModernCppStarter](https://github.com/TheLartians/ModernCppStarter)
@@ -184,9 +190,9 @@ Here are some useful resources to learn more:
184190

185191
---
186192

187-
## 🎗 License
193+
## 📃 License
188194

189-
This project is protected under the [MIT](LICENSE) License.
195+
This project is protected under the [MIT](LICENSE) License.
190196
For more details, refer to the [LICENSE](LICENSE) file.
191197

192198
---
6.13 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)