From 139acbb7a0de1a1a1fbb097b3e87c5a347911b32 Mon Sep 17 00:00:00 2001 From: Swarnava Mukherjee Date: Fri, 3 May 2024 19:56:36 +0530 Subject: [PATCH] doc: Update README.md Signed-off-by: Swarnava Mukherjee --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b2be075..a9e2993 100644 --- a/README.md +++ b/README.md @@ -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 ` (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 @@ -47,16 +48,18 @@ Note: Options: -create-project - Create a new project +create-project - Scaffold a new project -create-file - Generate header and respective C++ files under 'headers/' and 'src/' directories +create-file - Generate header and respective C++ files under 'headers/', 'src/' and 'test/' directories create-file - Same as above, but will create necessary sub-directories if required -compile-project - Compile all files and generate respective binaries under 'build/binaries/' +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 ``` @@ -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` | _
  • Requires completion of `project.cfg` parser first.
  • Need to add other strict and sane compiler flags.
_ | | 6 | Add support for various other C++ compilers | `💤 TBD` | _Requires a slight forward thinking mindset w.r.t. point 8 below_ |