Skip to content

Pre-configured skeleton directory for C++23 projects with a built-in CLI tool that lets you build with one command.

License

Notifications You must be signed in to change notification settings

JamieWells1/cpp_project_bootstrapper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

C++ Project Bootstrapper

This is a minimal, build-ready C++ project scaffold using CMake. It includes a clean directory layout and a built-in CLI tool (gold) to streamline setup, building, and execution.


Prerequisites

To use this project (via gold or manual build), you’ll need:

  • CMake: must be installed and available in your PATH
  • GTest: must be installed in order to run tests
  • Python 3: required to run the gold CLI tool

🚀 Quick Start (Recommended)

Use the included gold CLI to set up, build, and run your project.

⚠️ This is a macOS/Linux only tool. It will not work on Windows.

  1. Run install:

    ./goldpkg/install.sh
  2. Run project setup:

    gold setup
  3. Run your project:

    gold run

For more info, see the gold tool README:
https://github.com/JamieWells1/cpp_skeleton/blob/main/goldpkg/README.md


Manual Build (Optional)

If you prefer to build manually:

  1. Replace all instances of PROJECT_NAME with your actual project name.
  2. Create and enter a build directory:
    mkdir build
    cd build
  3. Configure and build:
    cmake ..
    cmake --build .
  4. Run your binary:
    ./bin/{PROJECT_NAME}

About

Pre-configured skeleton directory for C++23 projects with a built-in CLI tool that lets you build with one command.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published