Use mdbook for documentation (fixes #375)

1 files changed, 24 insertions, 0 deletions

diff --git a/docs/src/contributing_local_development.md b/docs/src/contributing_local_development.md
new file mode 100644
index 00000000..a681eeb0
--- /dev/null
+++ b/docs/src/contributing_local_development.md
@@ -0,0 +1,24 @@
+#### Requirements
+
+- [Rust](https://www.rust-lang.org/)
+- [Yarn](https://yarnpkg.com/en/)
+- [Postgres](https://www.postgresql.org/)
+
+#### Set up Postgres DB
+
+```bash
+ psql -c "create user lemmy with password 'password' superuser;" -U postgres
+ psql -c 'create database lemmy with owner lemmy;' -U postgres
+ export DATABASE_URL=postgres://lemmy:password@localhost:5432/lemmy
+```
+
+#### Running
+
+```bash
+git clone https://github.com/dessalines/lemmy
+cd lemmy
+./install.sh
+# For live coding, where both the front and back end, automagically reload on any save, do:
+# cd ui && yarn start
+# cd server && cargo watch -x run
+```