-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
readme: Modernize build and installation instruction
- Loading branch information
Showing
5 changed files
with
32 additions
and
74 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,4 +1,4 @@ | ||
build* | ||
build*/ | ||
Xcode/* | ||
*~ | ||
*.pyc | ||
|
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
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 |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Build and install from source with Pixi | ||
|
||
To build Coal from source the easiest way is to use [Pixi](https://pixi.sh/latest/#installation). | ||
|
||
[Pixi](https://pixi.sh/latest/) is a cross-platform package management tool for developers that | ||
will install all required dependencies in `.pixi` directory. | ||
It's used by our CI agent so you have the guarantee to get the right dependencies. | ||
|
||
Run the following command to install dependencies, configure, build and test the project: | ||
|
||
```bash | ||
pixi run test | ||
``` | ||
|
||
The project will be built in the `build` directory. | ||
You can run `pixi shell` and build the project with `cmake` and `ninja` manually. | ||
|