From 65d53af59435fcb8bd78c57cf55bb98f187b41ce Mon Sep 17 00:00:00 2001 From: adlee-was-taken Date: Sun, 21 Jun 2026 11:31:29 -0400 Subject: [PATCH] docs(user): fix getting-started onboarding blockers (git clone + git prereq) 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. --- user_docs/getting-started.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/user_docs/getting-started.md b/user_docs/getting-started.md index 34c96b2..ccdb41e 100644 --- a/user_docs/getting-started.md +++ b/user_docs/getting-started.md @@ -6,15 +6,23 @@ This page walks you through building Relicario from source, creating your first ## 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: ```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 relicario +cd relicario + +# 2. Build it — a fast debug build for trying things out… 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 ```