anchor-book/README.md

38 lines
927 B
Markdown
Raw Normal View History

# ⚓ The Anchor Book
Get up and running with [Anchor](https://anchor-lang.com), the framework for building secure, reliable
Solana apps.
## 🤝 Contributing
Feel free to file an issue or submit a pull request.
## 💻 Run The Anchor Book Locally
To run on a Mac, install [Homebrew](https://brew.sh/) if you don't already have
it.
Then, run the following commands:
```sh
brew upgrade
brew install mdbook
```
2022-02-22 09:50:45 -08:00
Next, clone this repo and and serve the book:
```sh
git clone https://github.com/project-serum/anchor-book.git
cd anchor-book
2022-02-22 09:50:45 -08:00
mdbook serve
```
2022-02-22 09:50:45 -08:00
The book will be available at `http://localhost:3000` in your browser.
2022-02-22 07:19:57 -08:00
## License
2022-02-22 07:19:57 -08:00
The Anchor Book is licensed under [Apache 2.0](./LICENSE).
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in Anchor by you, as defined in the Apache-2.0 license, shall be
licensed as above, without any additional terms or conditions.