2023-09-28 06:44:34 -07:00
|
|
|
> ⚠️ This project has been archived. please visit the [Wormhole Docs](https://docs.wormhole.com/)
|
|
|
|
|
|
2022-05-18 22:41:39 -07:00
|
|
|
# The xDapp Book
|
|
|
|
|
How to get started building cross chain applications with Wormhole
|
|
|
|
|
|
|
|
|
|
## Documentation
|
|
|
|
|
|
2022-08-10 03:23:07 -07:00
|
|
|
The book is hosted at [book.wormhole.com](https://book.wormhole.com)
|
2022-05-18 22:41:39 -07:00
|
|
|
|
|
|
|
|
## Projects
|
|
|
|
|
|
|
|
|
|
You can find the projects used in the book in the [projects directory](./projects/).
|
|
|
|
|
|
|
|
|
|
## Building the Book
|
|
|
|
|
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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Next, clone this repo and serve the book:
|
|
|
|
|
|
|
|
|
|
```sh
|
2022-08-23 11:27:22 -07:00
|
|
|
git clone https://github.com/wormhole-foundation/xdapp-book.git
|
2022-05-18 22:41:39 -07:00
|
|
|
cd xdapp-book
|
|
|
|
|
mdbook serve
|
|
|
|
|
```
|
|
|
|
|
The book will be available at `http://localhost:3000` in your browser.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
The xDapp Book is licensed under [Apache 2.0](./LICENSE).
|
|
|
|
|
|
|
|
|
|
Unless you explicitly state otherwise, any contribution intentionally submitted
|
|
|
|
|
for inclusion in xDapp Book by you, as defined in the Apache-2.0 license, shall be
|
2022-05-23 04:44:46 -07:00
|
|
|
licensed as above, without any additional terms or conditions.
|
