diff options
Diffstat (limited to 'docs')
| -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/#/)) |