Skip to content

Commit 82e7e79

Browse files
committed
Updating README
1 parent 883990c commit 82e7e79

1 file changed

Lines changed: 25 additions & 5 deletions

File tree

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
> **Moved:** This project has moved from [dejo1307/enola](https://github.com/dejo1307/enola) to [enola-labs/enola](https://github.com/enola-labs/enola). All references, imports, and URLs have been updated. The old repository will redirect to the new location.
2-
31
# enola
42

53
Give your AI agent a map of the codebase before it starts exploring.
@@ -41,13 +39,35 @@ The examples below show the enola output in action. Specific prompts were asking
4139

4240
## Quick Start
4341

44-
### Prerequisites
42+
### Install (recommended)
43+
44+
Grab a prebuilt binary for your platform with the install script — no Go toolchain or C compiler required:
45+
46+
```bash
47+
curl -fsSL https://raw.githubusercontent.com/enola-labs/enola/main/install.sh | sh
48+
```
49+
50+
This downloads the latest release, verifies its checksum, and installs `enola` to `~/.local/bin`. Set `ENOLA_INSTALL_DIR` to choose a different location:
51+
52+
```bash
53+
curl -fsSL https://raw.githubusercontent.com/enola-labs/enola/main/install.sh | ENOLA_INSTALL_DIR=/usr/local/bin sh
54+
```
55+
56+
Prebuilt binaries are published for Linux and macOS (amd64 and arm64) and Windows (amd64). If `~/.local/bin` is not on your `PATH`, add it:
57+
58+
```bash
59+
export PATH="$HOME/.local/bin:$PATH"
60+
```
61+
62+
You can also download a specific release manually from the [Releases page](https://github.com/enola-labs/enola/releases).
63+
64+
### Build from source
65+
66+
Prerequisites:
4567

4668
- Go 1.22+
4769
- C compiler (for tree-sitter CGo bindings)
4870

49-
### Build
50-
5171
```bash
5272
go build -o enola ./cmd/enola
5373
```

0 commit comments

Comments
 (0)