add readme

2023-10-24 06:36:52 -07:00 · 2023-10-24 06:36:52 -07:00 · 08fca1dabf
parent 80deb61e9c
commit 08fca1dabf
1 changed files with 29 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,29 @@
+# clubmanager
+
+### Running
+
+##### Run Database
+```
+docker-compose up
+```
+or
+```
+docker compose up
+```
+whichever works
+
+##### Run Web Server
+```
+cargo run
+```
+
+
+##### Reset database
+```
+docker compose down
+```
+or
+```
+docker-compose down
+```
+whichever works, then restart the database as above