mirror of
https://github.com/FuelLabs/sway.git
synced 2025-08-25 12:55:12 +00:00
ec90af2cfb
## Summary More information can be found in #2443 . Notes for PR: - The review is meant to take place using `mdbook` so check out the main `README.md` to see how to run it in the browser - This book is incomplete however there are a lot of pages so the idea is to PR this into the repo soon so that subsequent reviews are smaller - No CI added until the book is ready to replace the current book - Ideally reviews are split between multiple people because there is a lot of content Closes #2443 ## Pages Reviewed @matt-user : Program Types -> Functions, Misc Co-authored-by: Bikem <bengisuozaydin@gmail.com> Co-authored-by: Matt <54373384+matt-user@users.noreply.github.com> Co-authored-by: Cameron Carstens <54727135+bitzoic@users.noreply.github.com> Co-authored-by: bing <bingcicle@proton.me> Co-authored-by: Mitch Martin <111294749+mitch-fuel@users.noreply.github.com> Co-authored-by: Mohammad Fawaz <mohammadfawaz89@gmail.com> Co-authored-by: Luiz Felipe Bolsoni Gomes <8636507+LuizAsFight@users.noreply.github.com> Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com> Co-authored-by: Alex Hansen <alex@alex-hansen.com>
24 lines
528 B
Markdown
24 lines
528 B
Markdown
# The Sway Reference
|
|
|
|
## Setup
|
|
|
|
If you wish contribute to this reference:
|
|
|
|
1. Install [Rust](https://www.rust-lang.org/tools/install) if it's not installed.
|
|
2. Install [mdbook](https://rust-lang.github.io/mdBook/).
|
|
|
|
```bash
|
|
cargo install mdbook
|
|
```
|
|
|
|
3. To [build](https://rust-lang.github.io/mdBook/cli/build.html) the book, ensure you are in `/sway/sway-book` and run:
|
|
|
|
```bash
|
|
mdbook build
|
|
```
|
|
|
|
4. To serve a hot-reloading instance of the book in your browser, run:
|
|
|
|
```bash
|
|
mdbook serve --open
|
|
```
|