Skip to content
Snippets Groups Projects
Commit a4d56bb6 authored by Phil Höfer's avatar Phil Höfer
Browse files

Fix Documentation Formatting

parent 027a2b22
No related branches found
No related tags found
2 merge requests!10Resolve "Initial Documentation",!2Draft: Resolve "Initial Documentation"
...@@ -39,20 +39,18 @@ Building Suggestible is easy. Just start by making sure all dependencies are ins ...@@ -39,20 +39,18 @@ Building Suggestible is easy. Just start by making sure all dependencies are ins
## Using Suggestible ## Using Suggestible
1. **Run the Compiled Binary**: To see if everything went well and Suggestible runs you can try running it through Cargo with:
```sh
To see if everything went well and Suggestible runs you can try running it through Cargo with: cargo run --release
```sh ```
cargo run --release For further intructions on how to use Suggestible in your production setting refer to our [usage how-to](howto_basic.md)
```
For further intructions on how to use Suggestible in your production setting refer to our [usage how-to](howto_basic.md)
## Building the Documentation ## Building the Documentation
To build this documentation, simply call `make` with the `doc` target: To build this documentation, simply call `make` with the `doc` target:
```sh ```sh
make doc make doc
``` ```
This will generate the documentation in the `book` directory. This will generate the documentation in the `book` directory.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment