diff options
| author | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
|---|---|---|
| committer | Alex <alex@adnab.me> | 2022-02-07 11:51:12 +0100 |
| commit | 1c0ba930b8d6aa5d97e6942852240861e6ab9bed (patch) | |
| tree | cddc9af5fc2378c76fe5ef6306f807e27648b7a7 /doc/book/src/cookbook/from_source.md | |
| parent | 45d6d377d2011d8fb4ceb13bb4584df97c458525 (diff) | |
| download | garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.tar.gz garage-1c0ba930b8d6aa5d97e6942852240861e6ab9bed.zip | |
Reorganize documentation for new website (#213)
This PR should be merged after the new website is deployed.
- [x] Rename files
- [x] Add front matter section to all `.md` files in the book (necessary for Zola)
- [x] Change all internal links to use Zola's linking system that checks broken links
- [x] Some updates to documentation contents and organization
Co-authored-by: Alex Auvolat <alex@adnab.me>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/213
Co-authored-by: Alex <alex@adnab.me>
Co-committed-by: Alex <alex@adnab.me>
Diffstat (limited to 'doc/book/src/cookbook/from_source.md')
| -rw-r--r-- | doc/book/src/cookbook/from_source.md | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/doc/book/src/cookbook/from_source.md b/doc/book/src/cookbook/from_source.md deleted file mode 100644 index 167f01db..00000000 --- a/doc/book/src/cookbook/from_source.md +++ /dev/null @@ -1,51 +0,0 @@ -# Compiling Garage from source - - -Garage is a standard Rust project. -First, you need `rust` and `cargo`. -For instance on Debian: - -```bash -sudo apt-get update -sudo apt-get install -y rustc cargo -``` - -You can also use [Rustup](https://rustup.rs/) to setup a Rust toolchain easily. - -## Using source from `crates.io` - -Garage's source code is published on `crates.io`, Rust's official package repository. -This means you can simply ask `cargo` to download and build this source code for you: - -```bash -cargo install garage -``` - -That's all, `garage` should be in `$HOME/.cargo/bin`. - -You can add this folder to your `$PATH` or copy the binary somewhere else on your system. -For instance: - -```bash -sudo cp $HOME/.cargo/bin/garage /usr/local/bin/garage -``` - - -## Using source from the Gitea repository - -The primary location for Garage's source code is the -[Gitea repository](https://git.deuxfleurs.fr/Deuxfleurs/garage). - -Clone the repository and build Garage with the following commands: - -```bash -git clone https://git.deuxfleurs.fr/Deuxfleurs/garage.git -cd garage -cargo build -``` - -Be careful, as this will make a debug build of Garage, which will be extremely slow! -To make a release build, invoke `cargo build --release` (this takes much longer). - -The binaries built this way are found in `target/{debug,release}/garage`. - |