Skip to content

docs: clarify source and binary install paths #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TerminallyLazy merged 1 commit into from
Jul 23, 2026
+25 −4
Merged

docs: clarify source and binary install paths #44

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,20 +97,28 @@ guidance.

## Quick Start

Global user install:
Source install (requires Rust and Cargo):

```bash
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh
```

Linux x86_64 prebuilt install (glibc 2.36 or newer):

```bash
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh -s -- \
--archive-url https://github.com/TerminallyLazy/Tree-Ring-Memory/releases/download/v0.13.0/tree-ring-memory-0.13.0-linux-x86_64.tar.gz \
--archive-sha256 76966ec89990c0d10ab933733b1d0f601beec343cb90b64ee7f0655672b10a6a
```

macOS ARM64 install with Homebrew:

```bash
brew tap TerminallyLazy/tree-ring
brew install tree-ring
```

Project-local install with first-run initialization:
Project-local source install with first-run initialization (requires Cargo):

```bash
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh -s -- --project --init
Expand Down
7 changes: 6 additions & 1 deletion docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,9 +436,14 @@ <h2>Try it locally.</h2>
<li>Feedback flows through GitHub issue #26.</li>
</ul>
</div>
<pre><code># Portable installer
<pre><code># Source install (requires Rust and Cargo)
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh

# Linux x86_64 prebuilt (glibc 2.36+)
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh -s -- \
--archive-url https://github.com/TerminallyLazy/Tree-Ring-Memory/releases/download/v0.13.0/tree-ring-memory-0.13.0-linux-x86_64.tar.gz \
--archive-sha256 76966ec89990c0d10ab933733b1d0f601beec343cb90b64ee7f0655672b10a6a

# macOS ARM64 Homebrew tap
brew tap TerminallyLazy/tree-ring
brew install tree-ring
Expand Down
10 changes: 9 additions & 1 deletion docs/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,20 @@ ideas stay as seeds.
- Read-only agent-framework discovery.
- Terminal onboarding and a Ratatui operator console.

## Install
## Install From Source (Requires Rust and Cargo)

```bash
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh
```

Linux x86_64 prebuilt install (glibc 2.36 or newer):

```bash
curl -fsSL https://raw.githubusercontent.com/TerminallyLazy/Tree-Ring-Memory/main/install.sh | sh -s -- \
--archive-url https://github.com/TerminallyLazy/Tree-Ring-Memory/releases/download/v0.13.0/tree-ring-memory-0.13.0-linux-x86_64.tar.gz \
--archive-sha256 76966ec89990c0d10ab933733b1d0f601beec343cb90b64ee7f0655672b10a6a
```

macOS ARM64 Homebrew install:

```bash
Expand Down