Skip to content

Commit

Permalink
Merge pull request #451 from NikitaZotov/feat/ninja_description
Browse files Browse the repository at this point in the history
[docs] Describe using Ninja generator for CMake
  • Loading branch information
NikitaZotov authored Dec 17, 2024
2 parents 5ec2d77 + 9d5eaed commit 60dc8db
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/build/build_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ The project uses CMake as the build system generator. CMake allows for cross-pla
!!! warning
Our build system settings require using CMake 3.24 or newer. Make sure your version is compatible by running `cmake --version` and use the [CMake installation guide](https://cliutils.gitlab.io/modern-cmake/chapters/intro/installing.html) to upgrade to latest version if yours is older than 3.24. The universal method is to use `pipx install cmake` (don't forget to run `pipx ensurepath` and relaunching your shell after installation), but you may choose reconfiguring your OS's package manager instead.

!!! warning
By default, our build system use the Ninja generator for building (see CMakePresets.json). Ensure that Ninja is installed and properly configured in your environment. To upgrade it, use `pipx install ninja`. Don't forget to run `pipx ensurepath` and relaunching your shell after installation.

Typical configurations of the project are provided in the `CMakePresets.json` file – this means that if you use a modern IDE, **no additional configuration is needed**. Just pick one of the configurations provided by this file and use controls in your IDE to recompile and run tests (should work with VSCode + CMake Tools extension, JetBrains CLion and probably many others).

If you wish to use CLI instead, you can list all the available configurations in the `CMakePresets.json` file and pick one of the presets:
Expand Down
13 changes: 13 additions & 0 deletions docs/build/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@ To upgrade CMake, follow the installation guide appropriate for your OS or use:
# Use pipx to install cmake if not already installed
# Install pipx first using guide: https://pipx.pypa.io/stable/installation/
pipx install cmake
pipx ensurepath
# relaunch your shell after installation
```

Install Ninja generator for CMake, to use sc-machine CMake presets:

```sh
# Use pipx to install ninja if not already installed
pipx install ninja
pipx ensurepath
# relaunch your shell after installation
```

## Start develop sc-machine with Conan
Expand All @@ -27,6 +38,8 @@ Install Conan, to build sc-machine dependencies with Conan-provided dependencies
```sh
# Use pipx to install conan if not already installed
pipx install conan
pipx ensurepath
# relaunch your shell after installation
```

### Use sc-machine in Debug
Expand Down

0 comments on commit 60dc8db

Please sign in to comment.