Update Readme to mention setup script (R2Northstar#213)

* update the readme to explain how to run a dev server locally * Update README.rst Co-authored-by: NoCatt <[email protected]> --------- Co-authored-by: NoCatt <[email protected]>
eve-v0 · Sep 2, 2023 · 937bc2b · 937bc2b
1 parent 8a2e104
commit 937bc2b
Showing 1 changed file with 11 additions and 6 deletions.
diff --git a/README.rst b/README.rst
@@ -1,11 +1,16 @@
 Titanfall 2 + Northstar Modding Docs
 ====================================
 
-This repo contains the technical documentation on all things related to making Northstar
-mods.
+This repo contains documentation and guides on most things you need to know about creating mods for Northstar.
 
-Its currently in the early stages of development, so there might be some unpolished
-things about it.
+Especially the technical documentation is not done yet and might be incorrect or outdated in some places.
 
-If you have some knowledge you want to share, but don't want to write a PR, you can make
-a issue explaining what you know and we can try to integrate that into the docs.
+If you have some knowledge to share, but don't want to write a PR, you can make an issue explaining what you know and we can try to integrate that into the docs.
+
+Contributing
+------------
+
+The only prerequisites are python and pip. On Linux simply run `run.sh` in the root dir and in windows execute `run.ps1` with powershell in the root dir. You may need to change the Powershell execution policies in order to run the script.
+
+Running the script will install all dependencies required and build the docs locally. The local version is available at [port 8000](http://127.0.0.1:8000/). The server will get opened in your browser when the script finishes.
+When you change a file the server will automatically rebuild it and refresh your browser window.