alee/relicario
1
0
Fork 0
Code Issues Pull Requests 8 Actions Packages Projects Releases Wiki Activity

docs(user): fix getting-started onboarding blockers (git clone + git prereq)

Browse Source 
Docs-review found two gaps a first-time user would hit: the "clone the
repository" step had no actual `git clone` command, and git was not listed as
a prerequisite (it is needed to fetch the source and is how Relicario stores/
syncs the vault). Add an explicit clone+cd step and list git alongside Rust.
This commit is contained in:
adlee-was-taken
2026-06-21 11:31:29 -04:00
parent d0f757b66d
commit 65d53af594
1 changed files with 11 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
user_docs/getting-started.md
View File

@@ -6,15 +6,23 @@ This page walks you through building Relicario from source, creating your first
## 1. Build and install the CLI ## 1. Build and install the CLI
Relicario is currently distributed as source code, so you will need the Rust toolchain (`cargo`) installed. If you do not have it yet, visit [rustup.rs](https://rustup.rs) and follow the instructions there. Relicario is currently distributed as source code, so you will need two things installed first:
- **git** — to download the source code, and because Relicario stores and syncs your vault as a git repository. Get it from [git-scm.com](https://git-scm.com) or your system's package manager (`apt install git`, `brew install git`, and so on).
- **The Rust toolchain** (`cargo`) — to build the program. If you do not have it yet, visit [rustup.rs](https://rustup.rs) and follow the instructions there.
Clone the Relicario repository, then build the CLI: Clone the Relicario repository, then build the CLI:
```bash ```bash
# Fast debug build (good for trying things out) # 1. Download the source. Ask whoever set up Relicario for you for the
# repository URL — it points at your own Gitea or GitHub server.
git clone <repository-url> relicario
cd relicario
# 2. Build it — a fast debug build for trying things out…
cargo build -p relicario-cli cargo build -p relicario-cli
# Optimized release build (recommended for everyday use) # …or an optimized release build, recommended for everyday use:
cargo build --release -p relicario-cli cargo build --release -p relicario-cli
``` ```