Skip to content

Commit e256b6c

Browse files
committed
update: README
1 parent 3f7e5cf commit e256b6c

File tree

1 file changed

+60
-10
lines changed

1 file changed

+60
-10
lines changed

README.md

Lines changed: 60 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,77 @@
1-
<h1 align="center"> BLUECPPRINT </h1>
1+
<h1 align="center"> BLUECCPRINT </h1>
22

3-
A CLI utility to create a new C++ projects with a predefined structure inspired by Melkeydev's [go-blueprint](https://github.com/Melkeydev/go-blueprint) built in Go.
3+
A CLI utility to create a new C++ projects with a predefined structure inspired by Melkeydev's go-blueprint built in Go.
44

5-
## Getting Started
5+
## Setup
66

7-
### Pre-requisites
7+
### Requirements
88

99
* go
1010
* make
1111

12-
### Build & Install
12+
Clone the project
1313

14+
```bash
15+
$ git clone https://github.com/ErlanRG/bluecpprint
1416
```
15-
$ make && make install
17+
18+
Go to the project directory
19+
20+
```bash
21+
$ cd bluecpprint
22+
```
23+
24+
Build and install
25+
26+
```bash
27+
$ make && make install
1628
```
1729

30+
The binary will be installed in `$HOME/.local/bin/`
31+
1832
## Usage
1933

20-
Just provide the app a project name:
34+
Create a project
35+
36+
```bash
37+
$ bluecpprint <project_name>
38+
```
39+
40+
## Structure
41+
42+
Bluecpprint generates a simple project structure with some extra features:
2143

2244
```
23-
$ bluecpprint <project_name>
45+
my_project
46+
├── .git
47+
├── bin
48+
├── include
49+
├── src/
50+
│ └── main.cpp
51+
├── .clang-format
52+
├── .gitignore
53+
└── Makefile
2454
```
2555

26-
This will create a new C++ project structure under the current working
27-
directory.
56+
* Git repository automatically created.
57+
* Microsoft's clang-format configuration.
58+
* Makefile with build, clean and run scripts right of the bat
59+
60+
## Acknowledgements
61+
62+
- [go-blueprint](https://github.com/Melkeydev/go-blueprint) - Melkeydev
63+
- [readme.so](https://github.com/octokatherine/readme.so) - octokatherine
64+
65+
## Feedback
66+
67+
If you have any feedback, please reach out to me at [email protected]
68+
69+
## Contributing
70+
71+
Pull requests are more than welcome.
72+
For major changes, please submit a new issue.
73+
74+
## License
75+
76+
[MIT](https://choosealicense.com/licenses/mit/)
77+

0 commit comments

Comments
 (0)