diff --git a/Makefile b/Makefile index 36c0737..a6ec752 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,6 @@ build: @go build -o $(TARGET) $(SRC) 2>&1 run: - @echo "Running..." @go run $(SRC) install: build diff --git a/README.md b/README.md index 0a6ae21..92795c9 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@

BLUECCPRINT

-A CLI utility to create a new C++ projects with a predefined structure inspired by Melkeydev's go-blueprint built in Go. +A CLI utility to create a new C and C++ projects with a predefined structure inspired by Melkeydev's go-blueprint built in Go. ## Setup ### Requirements -* go -* make +* go (if you want to build from source) +* make (makes everything easier) Clone the project ```bash - $ git clone https://github.com/ErlanRG/bluecpprint + $ git clone --depth=1 https://github.com/ErlanRG/bluecpprint ``` Go to the project directory @@ -29,12 +29,20 @@ Build and install The binary will be installed in `$HOME/.local/bin/` +### Building from source + +Compile this using `go` + +``` + $ go build -o bluecpprint cmd/main.go +``` + ## Usage Create a project ```bash - $ bluecpprint + $ bluecpprint --language=[LANGUAGE] [PROJECT_NAME] ``` ## Structure @@ -47,7 +55,7 @@ my_project ├── bin ├── include ├── src/ -│ └── main.cpp +│ └── main.cpp // File extension will change depending on the selected language ├── .clang-format ├── .gitignore ├── Makefile