From 2dec288aa2bfefd83e5a2d3397913df414dec09b Mon Sep 17 00:00:00 2001 From: Fuwn Date: Mon, 22 Mar 2021 17:51:46 -0700 Subject: page: Brief development instructions --- src/SUMMARY.md | 1 + src/introduction/development.md | 14 ++++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 src/introduction/development.md (limited to 'src') diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 26f1759..cd8e43d 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -5,6 +5,7 @@ - [Resources](./introduction/resources.md) - [Workflow](./introduction/workflow.md) - [Contributing](./introduction/contributing.md) + - [Development](./introduction/development.md) - [The GammaDocs](./gamma_docs/gamma_docs.md) - [RoomServer]() diff --git a/src/introduction/development.md b/src/introduction/development.md new file mode 100644 index 0000000..720b99c --- /dev/null +++ b/src/introduction/development.md @@ -0,0 +1,14 @@ +# Development + +## Prerequisites +- [Rust](https://www.rust-lang.org/) +- [Worlds](http://archive.worlds.com/download.html) +- sqlx-cli + +## Installing sqlx-cli +Once Rust is installed, run `cargo install sqlx-cli`. + +## Setting up database +1. Navigate to the cloned instance of Whirl. +2. Create database file; `sqlx database create`. +3. Migrate database; `sqlx migrate run`. -- cgit v1.2.3