Skip to content

Commit

Permalink
Add meaningful content and add to ToC
Browse files Browse the repository at this point in the history
  • Loading branch information
magick93 committed Jan 12, 2025
1 parent be026f0 commit ffde278
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 2 deletions.
1 change: 1 addition & 0 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Summary

- [Introduction](./intro.md)
- [Installation](./installation.md)
- [Metrics](./metrics.md)
- [FAQs](./faq.md)
- [Development Environment](./setup.md)
Expand Down
69 changes: 67 additions & 2 deletions book/src/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,68 @@
# Installation guide
# Anchor Installation Guide

This guide provides step-by-step instructions for installing **Anchor**.

---

## 1. Download the Latest Release from GitHub

1. Visit the [Anchor Releases page](https://github.com/sigp/anchor/releases).
2. Download the appropriate binary for your operating system.
3. Extract the file if necessary and move the binary to a location in your `PATH` (e.g., `/usr/local/bin/`).

### Example:
```bash
wget https://github.com/sigp/anchor/releases/download/<version>/anchor-<platform>.tar.gz

# Replace <version> and <platform> with the appropriate values.

tar -xvf anchor-<platform>.tar.gz
sudo mv anchor /usr/local/bin/
```

Verify the installation:
```bash
anchor --version
```

---

## 2. Run Anchor Using Docker

1. Pull the latest Anchor Docker image:
```bash
docker pull sigp/anchor:latest
```
2. Run the Anchor container:
```bash
docker run --rm -it sigp/anchor:latest --help
```



## 3. Clone and Build Locally

1. Clone the Anchor repository:
```bash
git clone https://github.com/sigp/anchor.git
cd anchor
```

2. Build the Anchor binary:
```bash
cargo build --release
```
The binary will be located in `./target/release/`.

3. Move the binary to a location in your `PATH`:
```bash
sudo mv target/release/anchor /usr/local/bin/
```

Verify the installation:
```bash
anchor --version
```



How to install Anchor.

0 comments on commit ffde278

Please sign in to comment.