-
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
1 changed file
with
5 additions
and
3 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,12 +1,14 @@ | ||
# c3-cookbook | ||
|
||
This is a basic mdbook to provide examples of using [C3](https://c3-lang.org/). This is no way affiliated with the C3 project and is just a community project. | ||
This is a basic mdbook to provide examples of using [C3](https://c3-lang.org/). This is no way affiliated with the C3 project and is just a community made book. | ||
|
||
## Building | ||
## Building Locally | ||
|
||
To build the docs run: | ||
```sh | ||
$ mdbook build | ||
``` | ||
|
||
The docs will then be deployed onto github pages on commit. | ||
### Note | ||
|
||
The book will be automatically built through CI on commit to main. |