Skip to content

Commit

Permalink
doc: Update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Swarnava Mukherjee <[email protected]>
  • Loading branch information
swar-mukh committed May 3, 2024
1 parent 161ace9 commit 139acbb
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ The reason why proliferation of JavaScript has been so prominent is due to `npm`
- Unlike an `npm` project, ensure that all projects created with `cbt` strictly have the same folder structure
- Automatically create proper scaffold upon invocation of `cbt create-file <file_name>` (descriptions given below), and thereby reduce cognitive load
- First-class (and **type-safe**) support for `env` file(s)
- Unobtrusive and transparent `cbt_tools` offered to bring quality-of-life improvements as well as enable flexible customisation(s) as per project requirements

## Usage

Expand All @@ -47,16 +48,18 @@ Note:

Options:

create-project <project-name> - Create a new project
create-project <project-name> - Scaffold a new project

create-file <file_name> - Generate header and respective C++ files under 'headers/' and 'src/' directories
create-file <file_name> - Generate header and respective C++ files under 'headers/', 'src/' and 'test/' directories
create-file <path/to/file_name> - Same as above, but will create necessary sub-directories if required

compile-project - Compile all files and generate respective binaries under 'build/binaries/<respective-paths>'
compile-project - Compile all files and generate respective binaries under 'build/binaries/'
clear-build - Delete all object files under 'build/' directory

build-project - Perform linking and generate final executable under 'build/' (requires project compilation first)

run-unit-tests - Run all test cases under 'tests/unit_tests/' directory

info - Show information regarding cbt
help - Shows this help message
```
Expand Down Expand Up @@ -89,7 +92,7 @@ help - Shows this help message
|:-:|------|:------:|-------|
| 1 | Create a basic workable binary | `✅ Complete` ||
| 2 | Allow basic `create`, `compile` and `build` functionalities | `✅ Complete` ||
| 3 | Support scaffold for `test`ing | `⏳ In Progress` ||
| 3 | Support scaffold for `test`ing | `⛅ Partially achieved` | _Only unit tests supported currently_ |
| 4 | Use `project.cfg` as a one-stop configuration file for the entire project workspace management | `⏳ In Progress` |
| 5 | Decouple `g++` and all build configurations from source code | `💤 TBD` | _<ul><li>Requires completion of `project.cfg` parser first.</li><li>Need to add other strict and sane compiler flags.</li></ul>_ |
| 6 | Add support for various other C++ compilers | `💤 TBD` | _Requires a slight forward thinking mindset w.r.t. point 8 below_ |
Expand Down

0 comments on commit 139acbb

Please sign in to comment.