Go to file

Paul d8e8833dae version in title (#44 )		2022-03-21 18:49:33 -04:00
.github/workflows	add CNAME to gh-pages branch via ci (#3 )	2022-02-06 20:43:44 +01:00
programs/tic-tac-toe	update versions (#35 )	2022-03-12 21:43:29 -05:00
src	Fix broken link for Error Codes reference (#43 )	2022-03-21 18:46:07 -04:00
.gitignore	add programs dir and tic-tac-toe program (#21 )	2022-02-25 22:17:36 +01:00
CNAME	add master branch and build and deploy to gh pages via ci (#2 )	2022-02-06 20:35:56 +01:00
LICENSE	Add license (#17 )	2022-02-22 10:19:57 -05:00
README.md	older versions via branches (#29 )	2022-03-06 16:56:25 -05:00
book.toml	version in title (#44 )	2022-03-21 18:49:33 -04:00

README.md

⚓ The Anchor Book

Get up and running with Anchor, the framework for building secure, reliable Solana apps.

🤝 Contributing

Feel free to file an issue or submit a pull request.

Programs

You can find the program examples used in the book in the programs directory.

💻 Run The Anchor Book Locally

To run on a Mac, install Homebrew if you don't already have it.

Then, run the following commands:

brew upgrade
brew install mdbook

Next, clone this repo and and serve the book:

git clone https://github.com/project-serum/anchor-book.git
cd anchor-book
mdbook serve

The book will be available at http://localhost:3000 in your browser.

Run an older version

If you want to know how something worked in previous versions of anchor, you can check out a branch e.g. branch v0.21.0 is the branch with all commits of the book that were made before anchor v0.22.0 was released.

License

The Anchor Book is licensed under Apache 2.0.

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.