diff --git a/README.md b/README.md index 86b6adb..949b9cf 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +### Note + +The book will be automatically built through CI on commit to main. \ No newline at end of file