cinitpp

Initialise your C++ projects easily with cinitpp!

Table of contents

• cinitpp
  • Table of contents
  • License
  • Documentation
  • Usage
  • Future plans
  • Build instructions
    • Dependencies
    • Building

License

Copyright © 2023 Contributors

This project is licensed under the Apache license. View LICENSE for more details.

Documentation

JSON config format:

[
  {
    "Path": "./path/to/file.txt", 
    "Contents": "contents"
  }, 
  // ...
]

Usage

To initialise, use the following command:

cinitpp

To force an initialisation even when the current directory is not empty, use the following command:

cinitpp -F

To generate a config file, use the following command:

cinitpp -I <INPUT DIRECTORY>

Note, the directory MUST follow IMMEDIATELY AFTER the flag -I.

Usage of -I and -F will ignore -F.

Future plans

• Making it configurable
• Making it save the configuration

Build instructions

Dependencies

• Nlohmann-json

Building

You can use the makefile as reference. TLDR:

• Standard = C++17
• Source = src/main.cc main.exe
• Additional include paths =
• If possible, -Wall -Wextra -Werror (Though I wouldn't mind if there were warnings, I'd still attempt to correct them, so to save time, it'd be best to use all warnings)