Skip to content

Commit 650e520

Browse files
committed
feat: add README template
1 parent d56e7a7 commit 650e520

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

internal/templates/README.md.tmpl

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,44 @@
1-
# Project {{.ProjectName}}
1+
<h1 align="center">
2+
Project {{.ProjectName}}
3+
</h1>
24

3-
Description goes here.
5+
<div align="center">
6+
Description goes here.
7+
</div>
48

59
## Build the project
610

711
### Compile
812

913
Binaries will be placed inside the `bin` directory. To build the project just run:
1014
```bash
11-
make
15+
$ make
1216
```
1317

18+
If `make` is not installed in your machine, then go the old way:
19+
```
20+
$ g++ -O2 -Wall -Wextra -Wfatal-errors -pedantic -Iinclude src/*.cpp -o bin/main
21+
```
22+
23+
> [!IMPORTANT]
24+
> This `g++` command uses some compilations flags to show relevant warnings.
25+
> A more detailed documentation on these flags is located [here](https://bytes.usc.edu/cs104/wiki/gcc/).
26+
1427
### Build & run
1528

1629
To compile and run the application:
1730
```bash
18-
make run
31+
$ make run
32+
```
33+
34+
Or just run the following command from the root directory
35+
```
36+
$ ./bin/main
1937
```
2038

2139
### Clean `bin` directory
2240

2341
Clean the `bin` directory using the following command:
2442
```bash
25-
make clean
43+
$ make clean
2644
```

0 commit comments

Comments
 (0)