-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
21 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,18 @@ | ||
# Building | ||
# Building and Installing | ||
## Prerequisites | ||
1. Compiler that supports C++20. Recommended compilers: `MSVC 19.3` (`Visual Studio 2022`) or higher, `GCC 12` or higher, `Clang 15` or higher. | ||
2. `CMake`: `3.20` or higher. | ||
3. `Ninja` | ||
|
||
## Build the Project | ||
### Configure | ||
```bash | ||
mkdir build | ||
cd build | ||
cmake .. | ||
Run `build.sh` from the project root directory. For Windows, run `build.ps1` instead. | ||
```sh | ||
./build.sh -DCMAKE_BUILD_TYPE=Release | ||
``` | ||
If you need to build examples or unit tests, add the parameter `-Dpapilio_build_example=1` or `-Dpapilio_build_unit_test=1`. | ||
Document for more build options are in the [Custom Build](custom_build.md). | ||
### Compile | ||
```bash | ||
cmake --build . | ||
``` | ||
### Run Unit Tests | ||
```bash | ||
ctest . | ||
```ps1 | ||
# Windows | ||
./build.ps1 -DCMAKE_BUILD_TYPE=Release | ||
``` | ||
|
||
## Install the Library | ||
Run `cmake --install` in the `build/` directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters