From da980bd8eb5912dc5b0097038669b38f8db03a37 Mon Sep 17 00:00:00 2001
From: GeckoEidechse <gecko.eidechse+git@pm.me>
Date: Fri, 26 Aug 2022 13:25:38 +0200
Subject: Add development guide to README

---
 README.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 272d2dae..6560fbd4 100644
--- a/README.md
+++ b/README.md
@@ -41,4 +41,36 @@ Then
 ```rs
 tauri::Builder::default()
 	.manage(arc_db)
-```
\ No newline at end of file
+```
+
+## Development
+
+Make sure you have the necessary dependencies installed: https://tauri.app/v1/guides/getting-started/prerequisites
+
+
+Install `npm` dependencies with 
+
+```sh
+npm install
+```
+
+Then for developing
+
+```sh
+# terminal 1 (UI localhost for hot-reload)
+npm run ui-dev
+
+# terminal 2 (for the Rust/App hot-reload)
+npm run tauri dev
+```
+
+> **Note**
+> On Windows instead of `npm run ui-dev`, you may need to run 
+> `./node_modules/.bin/rollup --config --watch`
+> and
+> `npm run localhost`
+> in two separate console windows
+
+### Building
+
+Release builds are generally done via CI. To build locally, make sure typescript is compiled (`./node_modules/.bin/rollup --config`), then run `npm run tauri build`.
-- 
cgit v1.2.3