d9d5cb15a2
## Description Adds module level docs & previews to `forc doc`. [Screencast from 2023-02-20 20-30-24.webm](https://user-images.githubusercontent.com/57543709/220232486-7ec0742a-59ef-41c9-a459-3c8c9b7d42c7.webm) ## Checklist - [x] I have linked to any relevant issues. Closes #4095 - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. |
||
|---|---|---|
| .github | ||
| deployment | ||
| docs | ||
| examples | ||
| forc | ||
| forc-pkg | ||
| forc-plugins | ||
| forc-test | ||
| forc-tracing | ||
| forc-util | ||
| scripts | ||
| sway-ast | ||
| sway-core | ||
| sway-error | ||
| sway-ir | ||
| sway-lib-core | ||
| sway-lib-std | ||
| sway-lsp | ||
| sway-parse | ||
| sway-types | ||
| sway-utils | ||
| swayfmt | ||
| templates | ||
| test | ||
| .gitattributes | ||
| .gitignore | ||
| .markdownlint.yaml | ||
| .markdownlintignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| ci_checks.sh | ||
| clippy.toml | ||
| LICENSE | ||
| README.md | ||
| rustfmt.toml | ||
Sway
Sway is a language developed for the Fuel blockchain. It is heavily inspired by Rust and aims to bring modern language development and performance to the blockchain ecosystem.
Documentation
For user documentation, including installing release builds, see the Sway Book: https://fuellabs.github.io/sway/latest/.
Also view the technical reference for the Sway programming language: https://fuellabs.github.io/sway/master/reference/
Building from Source
This section is for developing the Sway compiler and toolchain. For developing contracts and using Sway, see the above documentation section.
Dependencies
Sway is built in Rust. To begin, install the Rust toolchain following instructions at https://www.rust-lang.org/tools/install. Then configure your Rust toolchain to use Rust stable:
rustup default stable
If not already done, add the Cargo bin directory to your PATH by adding the following line to ~/.profile and restarting the shell session.
export PATH="${HOME}/.cargo/bin:${PATH}"
Building Forc
Clone the repository and build the Sway toolchain:
git clone git@github.com:FuelLabs/sway.git
cd sway
cargo build
Confirm the Sway toolchain built successfully:
cargo run --bin forc -- --help
Contributing to Sway
We welcome contributions to Sway!
Please see the Contributing To Sway section of the Sway book for guidelines and instructions to help you get started.