diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b34ce6 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Market + +Market simulator. + +Details coming soon... + +# Running + +1. Install pipenv with `pip3 install --user pipenv` (make sure `$HOME/.local/bin` is in your `PATH`!) +2. Run `pipenv run ./local-manage.sh migrate` to create a local database +3. Run `pipenv run ./local-manage.sh createsuperuser` to create a superuser. +4. Run `pipenv run ./local-manage.sh runserver` to run a local server. + +Navigate to the address given to you in the terminal, and log in from there.