Skip to content

QUICK_START.md

Latest commit

 

History

History
131 lines (96 loc) · 2.92 KB

QUICK_START.md

File metadata and controls

131 lines (96 loc) · 2.92 KB
Raw

Regedited Quick Start

Regedited is a Rust CLI for treating one plaintext/markdown file as a fast indexed registry. It scans canonical regedited open trigger lines or compatible ## SECTION: headers, then reads, writes, diffs, copies, and serves typed string, DB, and hex-word zone refs.

1. Install Rust

Windows:

winget install --source winget --id Rustlang.Rustup

Close and reopen the shell, then verify:

rustc --version
cargo --version
rustup --version

If Windows reports a linker error such as link.exe not found, install Visual Studio Build Tools with the Desktop development with C++ workload.

Linux/macOS:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
rustc --version
cargo --version

2. Build and Test

cargo fmt --check
cargo test
cargo build --release

Windows binary:

.\target\release\regedited.exe --help

Linux/macOS binary:

./target/release/regedited --help

3. Minimal Registry Fixture

anything before regedited open anything after is ignored
index: 1
0x0000008 : 0x0000008 : 0x0000000 : 0x0000000 : 0x0000000 : 0x0000000
1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
First string line
Second string line
Third string line
---
Hello from a zone.

The trigger line has no name. The address is the following numeric index:

regedited ref-get doc.md index:1:string:1
regedited ref-get doc.md index:1:db:7
regedited ref-get doc.md index:1:zone:1
regedited ref-get doc.md index:1:zone:1 --clip

4. Enable Concise Commands

The helper adds the release directory to PATH and creates rgd as another name for the same compiled executable:

Windows:

.\pathadd.ps1
rgd load .\doc.md
rgd l
rgd ist 1
rgd unload

Linux:

./pathadd.sh
rgd load ./doc.md
rgd l
rgd ist 1
rgd unload

An omitted document is accepted only after rgd load. Explicit paths always take precedence, and canonical regedited remains stateless.

5. Build The Browser Package

Windows:

.\webbuild.ps1

Linux:

./webbuild.sh

These scripts check for Rust and wasm-pack, ask before installing a missing tool, and build the package under web/pkg. The browser surface is read-only.

6. Read More

  • docs/RUST_BEGINNER_SETUP.txt - slower first-time Rust setup
  • docs/shell/POWERSHELL.txt - PowerShell command cookbook
  • docs/shell/BASH.txt - Bash command cookbook
  • docs/shell/PYTHON.txt - Python subprocess cookbook
  • docs/shell/REPL.txt - evcxr and direct-process cookbook
  • docs/shell/BAT.txt - CMD and batch cookbook
  • docs/web/JAVASCRIPT.txt - browser runner and Wasm APIs
  • docs/web/STANDALONE_HTML.txt - static-page module layout
  • docs/ARCHITECTURE.md - full internals and command reference
  • docs/FORMAT.md - minimal document format