-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a quick start to the book (#202)
- Loading branch information
Showing
3 changed files
with
43 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Quick start | ||
|
||
## Repository setup | ||
|
||
Clone the repository and run the setup script: | ||
|
||
```sh | ||
git clone https://github.com/google/wasefire | ||
cd wasefire | ||
./scripts/setup.sh | ||
``` | ||
|
||
The setup script is best effort. When possible, it will directly invoke | ||
installation commands, possibly asking for sudo password. Otherwise, it will | ||
return an error and print a message about the next manual step. Once the problem | ||
is addressed, the script must be run again. The script will eventually return a | ||
success code indicating that no manual step is required and everything seems in | ||
order. | ||
|
||
## Run an applet | ||
|
||
If you don't have a Nordic board, you can run applets on your desktop: | ||
|
||
```sh | ||
cargo xtask applet assemblyscript hello runner host | ||
``` | ||
|
||
If you have an nRF52840 dev-kit, you can also run applets on the board: | ||
|
||
```sh | ||
cargo xtask applet rust blink runner nordic | ||
``` | ||
|
||
The general format is `cargo xtask applet LANGUAGE NAME runner BOARD`. Example | ||
applets are listed in the `examples` directory by _language_ then _name_. | ||
_Boards_ are listed under the `crates` directory and are prefixed by `runner-`. | ||
|
||
Feel free to stop and play around by directly editing the examples. Or continue | ||
reading for a deeper tutorial on how to write applets in Rust. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters