Skip to content

Commit 95e3374

Browse files
docs: refine README onboarding and docs links
1 parent e0f0c35 commit 95e3374

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@
1515

1616
[Quick Start](#-quick-start)[Installation](#-installation-today)[Architecture](#-architecture)[Capabilities](#-core-capabilities)[Documentation](#-documentation)
1717

18-
---
19-
2018
</div>
2119

2220
---
@@ -83,6 +81,12 @@ This public repo is meant to be:
8381

8482
Two fast paths:
8583

84+
Prerequisites for both paths:
85+
- Python 3.11+
86+
- `git`
87+
- `bash`
88+
- `ripgrep`
89+
8690
### A. Fastest Path From A Repo Checkout
8791

8892
Best for:
@@ -125,12 +129,14 @@ hyperclaw-validate-config "$TARGET_ROOT/config/openclaw.public.example.jsonc"
125129
hyperclaw-ops-fabric summary --state-dir "$TARGET_ROOT/runtime/state"
126130
```
127131

128-
### Optional Smoke
132+
### Optional Smoke Test
129133

130134
```bash
131135
PYTHONPATH=src python3 -m hyperclaw_max.context_intel.pack "telegram inbound dedupe" --repo . --format human
132136
```
133137

138+
Use this as a quick sanity check for the shipped `context-intel` surface.
139+
134140
**What this proves:**
135141
- the public core works from a source checkout
136142
- the same surfaces are exposed as installed CLI entrypoints
@@ -377,6 +383,8 @@ This is intentional:
377383

378384
## 🆚 Why Not Just Use OpenClaw?
379385

386+
OpenClaw is the open-source base framework that HyperClaw-Max builds upon.
387+
380388
| Feature | Stock OpenClaw | HyperClaw-Max |
381389
|---------|---------------|---------------|
382390
| Agents | single or ad-hoc | persistent specialist pack |
@@ -415,7 +423,11 @@ These lanes are documented as part of the product direction, but are not yet shi
415423
| [docs/CLI.md](docs/CLI.md) | command reference and install surfaces |
416424
| [docs/BOUNDARIES.md](docs/BOUNDARIES.md) | public core vs optional adapters vs private overlay |
417425
| [install/connectors/README.md](install/connectors/README.md) | connector templates and required inputs |
426+
| [install/systemd/README.md](install/systemd/README.md) | public-safe gateway service templates |
418427
| [install/overlay/README.md](install/overlay/README.md) | pack materialization over a clean base install |
428+
| [examples/README.md](examples/README.md) | sample outputs and reviewer-facing examples |
429+
| [examples/quickstart/README.md](examples/quickstart/README.md) | quickstart example outputs |
430+
| [CHANGELOG.md](CHANGELOG.md) | notable repo changes over time |
419431
| [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) | detailed system design |
420432
| [docs/MEMORY-FABRIC.md](docs/MEMORY-FABRIC.md) | layered memory model |
421433
| [docs/OPERATIONAL-FABRIC.md](docs/OPERATIONAL-FABRIC.md) | public task / delegation / watchdog base |

0 commit comments

Comments
 (0)