Skip to content

Commit

Permalink
update: README
Browse files Browse the repository at this point in the history
  • Loading branch information
ErlanRG committed Sep 26, 2024
1 parent e6ddc15 commit a66b33d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ build:
@go build -o $(TARGET) $(SRC) 2>&1

run:
@echo "Running..."
@go run $(SRC)

install: build
Expand Down
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
<h1 align="center"> BLUECCPRINT </h1>

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
Expand All @@ -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 <project_name>
$ bluecpprint --language=[LANGUAGE] [PROJECT_NAME]
```

## Structure
Expand All @@ -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
Expand Down

0 comments on commit a66b33d

Please sign in to comment.