Skip to content

Commit 6728607

Browse files
committed
Update README.md
1 parent 791f4d3 commit 6728607

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Make](https://img.shields.io/badge/Build-Make-6D00CC?style=flat&logo=cmake&logoColor=white)](https://www.gnu.org/software/make/)
44
![Platform](https://img.shields.io/badge/Platform-Windows%20%7C%20Linux-lightgrey?style=flat)
5-
[![C](https://img.shields.io/badge/Language-C-A8B9CC?style=flat&logo=c)](https://en.wikipedia.org/wiki/C_(programming_language))
5+
[![C](https://img.shields.io/badge/Language-C-A8B9CC?style=flat&logo=c)](<https://en.wikipedia.org/wiki/C_(programming_language)>)
66
[![C++](https://img.shields.io/badge/Language-C%2B%2B-00599C?style=flat&logo=cplusplus&logoColor=white)](https://isocpp.org/)
77
![Status](https://img.shields.io/badge/Status-Stable-success?style=flat)
88

@@ -25,6 +25,31 @@ Designed to be simple, readable, and easy to extend, ideal for game engines, too
2525
- Assembly generation (`make asm`) and binary disassembly (`make disasm`)
2626
- Multi-core parallel builds support with clean handling
2727

28+
## 🚩 Quick Start - Run the Examples
29+
30+
In the root directory are a main **Makefile** for building two simple examples:
31+
- **Spinning ASCII Donut**: A terminal-based 3D donut animation (in `examples/donut-basic/`)
32+
- **ImGui + GLFW Demo**: A graphical window using ImGui and GLFW (in`examples/ImGui/`)
33+
34+
### Clone the repository
35+
36+
```bash
37+
git clone https://github.com/DMsuDev/Basic-Makefile-Template.git
38+
cd Basic-Makefile-Template
39+
```
40+
41+
### Steps to build and run the examples:
42+
43+
```Bash
44+
# Option 1: View the spinning ASCII donut (terminal animation)
45+
make run-donut
46+
47+
# Option 2: Open the ImGui window (graphical demo with GLFW)
48+
make run-imgui
49+
```
50+
51+
> If you want to know more commands type in the terminal `make help`
52+
2853
## Main Commands
2954

3055
| Command | Description | When to use |
@@ -65,6 +90,7 @@ make run -j12
6590
- This prevents the terminal from becoming a mess when compiling dozens/hundreds of files at once.
6691

6792
- **Note**: Start with `-j4` or `-j8` and increase until you find the sweet spot for your machine (too high can cause memory thrashing if RAM is limited).
93+
- **On linux**: The verbose mode not deactivates automatically, so you can use `-s` to reduce output if needed.
6894

6995
## ⚙️ Customization
7096

@@ -74,7 +100,7 @@ These variables control the behavior of the project and can be overridden direct
74100

75101
| Variable | Description | Default |
76102
| ---------------- | ------------------------------------- | ------------- |
77-
| **APP_NAME** | Output executable name (no extension) | `MyProject` |
103+
| **APP_NAME** | Output executable name (no extension) | `ProjectName` |
78104
| **SRC_EXT** | Source file extension | `cpp` |
79105
| **LANGUAGE** | C/C++ standard | `c++23` |
80106
| **CXX** | Compiler to use | `g++` |

0 commit comments

Comments
 (0)