https://github.com/linbreux/cpp-basic-template

A basic C++ template that uses nix
https://github.com/linbreux/cpp-basic-template

catch2 cpp getting-started nix template

Last synced: 9 days ago
JSON representation

A basic C++ template that uses nix

• Host: GitHub
• URL: https://github.com/linbreux/cpp-basic-template
• Owner: Linbreux
• Created: 2023-12-01T11:15:10.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-03T14:41:27.000Z (about 1 year ago)
• Last Synced: 2025-01-21T10:17:56.863Z (15 days ago)
• Topics: catch2, cpp, getting-started, nix, template
• Language: CMake
• Homepage:
• Size: 40 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    



C++ Simple Template


This project is meant to be a starting point, to quickly start working on a C++ program. 

This can be ether way, *with* or *without* using *Nix*.

There are some libraries that are by default available:

- boost

- spdlog

- yaml-cpp

- nlohmann_json

- protobuf

## How to get started

Like already mentioned, you have two ways to run the program.

### Nix

> *(optional)* You can use [direnv](https://direnv.net/) to drop you instantly in a nix-shell session 

> when opening the project folder

> Just run `direnv allow .` one time in the project after installing `direnv`.

Open the `default.nix` file and edit `project_name` to the name you want.

This is also the main file where you would at libraries, change the compiler version, etc.

You should of course still add the libraries that you added to your `CMakeLists.txt` file.

To build the program, run:

```

nix-build

```

`nix-build` will create a new symbolic link, containing a link the program. 

To run the program:

```

./result/bin/

```

You could also start a shell by running `nix-shell`. This will create a shell that has links to all the 

libraries/programs defined in `default.nix`. From there it's also possible to compile the program yourself.

> By doing this, you should set the `CMAKE_PROJECT_NAME` in the `CMakeLists.txt` to the project name you want.

```

mkdir build && cd build

cmake ../src/. . && cmake --build .

```

### Without Nix

If you are not using nix, you should first make sure that you have all the libraries and compilers you need.

> You can change the project name by changing `CMAKE_PROJECT_NAME` in the `CMakeLists.txt`.

After that you can just build the project manually:

```

mkdir build && cd build

cmake ../src/. . && cmake --build .

```