docs(setup): put all setup scripts into a folder

napse-invest · Dec 21, 2023 · 5b2f910 · 5b2f910
1 parent 14b8a53
commit 5b2f910
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 154 deletions.
diff --git a/Makefile b/Makefile
@@ -6,11 +6,11 @@ all: setup-testing-environment makemigrations migrate runserver
 
 setup:
 ifeq ($(OS),Darwin)        # Mac OS X
-	./setup-osx.sh
+	./setup/setup-osx.sh
 else ifeq ($(OS),Linux)
-	./setup-unix.sh
+	./setup/setup-unix.sh
 else 
-	./setup-windows.sh
+	./setup/setup-windows.sh
 endif
 
 setup-testing-environment:

diff --git a/README.md b/README.md
@@ -28,7 +28,16 @@
 <br/>
 
 ## django-napse
-....
+
+Django napse is a portfolio management module using trading bots.
+
+This directory can be used as a django module, which you can install as follows:
+
+```bash
+pip install django-napse
+```
+
+Or you can use it as a local backend for the [Napse desktop application](https://github.com/napse-invest/Napse), by cloning the repo (possibly after forking it).
 
 ## Useful commands
 Unless otherwise specified, all commands are to be run at the root folder of the project.

diff --git a/docs/contributing.md b/docs/contributing.md
@@ -64,13 +64,19 @@ You can commit the code from your fork through a pull request on the official re
 === "Linux"
 
     ```bash
-    source setup-unix.sh
+    source setup/setup-unix.sh
+    ```
+
+=== "MacOS"
+
+    ```bash
+    source setup/setup-osx.sh
     ```
 
 === "Windows"
 
     ```powershell
-    .\setup-windows.ps1
+    .\setup\setup-windows.ps1
     ```
 
 #### Setup initial exchange accounts

diff --git a/docs/api.md → docs/sources/api.md b/docs/api.md → docs/sources/api.md
diff --git a/docs/theme/assets/stylesheets/docstring.css b/docs/theme/assets/stylesheets/docstring.css
diff --git a/docs/theme/partials/header.html b/docs/theme/partials/header.html
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -167,8 +167,8 @@ nav:
     - "sources/reference/spaces.md"
     - "sources/reference/transactions.md"
     - "sources/reference/wallets.md"
-  - API: "api.md"
+  - API: "sources/api.md"
   - Development: 
     - Contributing: "contributing.md"
     - Security: "SECURITY.md"
-    - Coverage: coverage.md
+    - Coverage: coverage.md
diff --git a/setup-osx.sh → setup/setup-osx.sh b/setup-osx.sh → setup/setup-osx.sh
diff --git a/setup-unix.sh → setup/setup-unix.sh b/setup-unix.sh → setup/setup-unix.sh
diff --git a/setup-windows.ps1 → setup/setup-windows.ps1 b/setup-windows.ps1 → setup/setup-windows.ps1