Go to file

Armani Ferrante ae22ed36b2 Add license (#17 )		2022-02-22 10:19:57 -05:00
.github/workflows	add CNAME to gh-pages branch via ci (#3 )	2022-02-06 20:43:44 +01:00
src	cpi and pda chapter (#7 )	2022-02-22 12:36:04 +01:00
.gitignore	add master branch and build and deploy to gh pages via ci (#2 )	2022-02-06 20:35:56 +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	Add license (#17 )	2022-02-22 10:19:57 -05:00
book.toml	add master branch and build and deploy to gh pages via ci (#2 )	2022-02-06 20:35:56 +01: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.

💻 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 run mbdbook to build the book:

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

Now, assuming you have node.js and npm installed, install serve, a static file server.

npm i -g serve

Now, run:

cd book && serve

and then navigate to http://localhost:3000 in your browser.

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.