-
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
1 parent
14b17c8
commit 3694a94
Showing
1 changed file
with
67 additions
and
2 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,3 +1,68 @@ | ||
# Clafrica Manual | ||
<div align="center"> | ||
|
||
Repository for the Clafrica Manual. | ||
<h1>The Clafrica Book</h1> | ||
|
||
<strong>This small book describes how to use clafrica.</strong> | ||
|
||
<h3> | ||
<a href="https://pythonbrad.github.io/clafrica-man/">Read the Book</a> | ||
<span> | </span> | ||
<a href="https://github.com/pythonbrad/clafrica/blob/main/CONTRIBUTING.md">Contributing</a> | ||
<span> | </span> | ||
<a href="https://discord.gg/vybUPCFV">Chat</a> | ||
</h3> | ||
|
||
<sub>Built with 🦀🕸</sub> | ||
</div> | ||
|
||
## About | ||
|
||
This repo contains documentation on using clafrica, how | ||
to get started and more as you dive deeper. It acts as a guide for doing some really neat things with clafrica. | ||
|
||
If you would like to start learning how to use clafrica, | ||
you can read the book [online here][book]. | ||
|
||
[Open issues for improving the Clafrica book.][book-issues] | ||
|
||
## Building the Book | ||
|
||
The book is made using [`mdbook`][mdbook]. To install it you'll need `cargo` | ||
installed. If you don't have any Rust tooling installed, you'll need to install | ||
[`rustup`][rustup] first. Follow the instructions on the site in order to get | ||
setup. | ||
|
||
Once you have that done then just do the following: | ||
|
||
```bash | ||
$ cargo install mdbook | ||
``` | ||
|
||
Make sure the `cargo install` directory is in your `$PATH` so that you can run | ||
the binary. | ||
|
||
Now just run this command from this directory: | ||
|
||
```bash | ||
$ mdbook build | ||
``` | ||
|
||
This will build the book and output files into a directory called `book`. From | ||
there you can navigate to the `index.html` file to view it in your browser. You | ||
could also run the following command to automatically generate changes if you | ||
want to look at changes you might be making to it: | ||
|
||
```bash | ||
$ mdbook serve | ||
``` | ||
|
||
This will automatically generate the files as you make changes and serves them | ||
locally so you can view them easily without having to call `build` every time. | ||
|
||
The files are all written in Markdown so if you don't want to generate the book | ||
to read them then you can read them from the `src` directory. | ||
|
||
[mdbook]: https://github.com/rust-lang-nursery/mdBook | ||
[rustup]: https://github.com/rust-lang-nursery/rustup.rs/ | ||
[book]: https://pythonbrad.github.io/clafrica-man | ||
[book-issues]: https://github.com/pythonbrad/clafrica-man/issues |