Skip to content

Commit a66b33d

Browse files
committed
update: README
1 parent e6ddc15 commit a66b33d

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ build:
1010
@go build -o $(TARGET) $(SRC) 2>&1
1111

1212
run:
13-
@echo "Running..."
1413
@go run $(SRC)
1514

1615
install: build

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
<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 built in Go.
3+
A CLI utility to create a new C and C++ projects with a predefined structure inspired by Melkeydev's go-blueprint built in Go.
44

55
## Setup
66

77
### Requirements
88

9-
* go
10-
* make
9+
* go (if you want to build from source)
10+
* make (makes everything easier)
1111

1212
Clone the project
1313

1414
```bash
15-
$ git clone https://github.com/ErlanRG/bluecpprint
15+
$ git clone --depth=1 https://github.com/ErlanRG/bluecpprint
1616
```
1717

1818
Go to the project directory
@@ -29,12 +29,20 @@ Build and install
2929

3030
The binary will be installed in `$HOME/.local/bin/`
3131

32+
### Building from source
33+
34+
Compile this using `go`
35+
36+
```
37+
$ go build -o bluecpprint cmd/main.go
38+
```
39+
3240
## Usage
3341

3442
Create a project
3543

3644
```bash
37-
$ bluecpprint <project_name>
45+
$ bluecpprint --language=[LANGUAGE] [PROJECT_NAME]
3846
```
3947

4048
## Structure
@@ -47,7 +55,7 @@ my_project
4755
├── bin
4856
├── include
4957
├── src/
50-
│ └── main.cpp
58+
│ └── main.cpp // File extension will change depending on the selected language
5159
├── .clang-format
5260
├── .gitignore
5361
├── Makefile

0 commit comments

Comments
 (0)