diff options
| author | Fuwn <[email protected]> | 2021-04-27 17:29:32 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-04-27 17:29:32 -0700 |
| commit | 4f8f9a25fc25275e81b56c350888a4d73c57b578 (patch) | |
| tree | 938f551bd00b75e76b280c871df4bfcfcad55013 /docs/introduction | |
| parent | fix: Badge style (diff) | |
| download | site-4f8f9a25fc25275e81b56c350888a4d73c57b578.tar.xz site-4f8f9a25fc25275e81b56c350888a4d73c57b578.zip | |
docs: Add dev-env setup instructions
Diffstat (limited to 'docs/introduction')
| -rw-r--r-- | docs/introduction/setting_up_a_development_environment.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/introduction/setting_up_a_development_environment.md b/docs/introduction/setting_up_a_development_environment.md new file mode 100644 index 0000000..47f849f --- /dev/null +++ b/docs/introduction/setting_up_a_development_environment.md @@ -0,0 +1,15 @@ +--- +title: Setting up a development environment +--- + +## Prerequisites +- [NPM](https://nodejs.org/en/) (Effectively, Node) or [Yarn](https://yarnpkg.com/) (I prefer + Yarn... ~Fuwn) +- [Rustup](https://rustup.rs/) + +## Steps +1. Clone the Whirl [repository](https://github.com/Whirlsplash/whirl) +2. Override Rust tool-chain; `rustup override set nightly-2021-02-20` +2. Download dependencies + 1. `cargo build` (for Rust crates) + 2. `npm i` or `yarn` (for [Husky](https://typicode.github.io/husky/#/)) |