aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubenwardy <rw@rubenwardy.com>2019-01-09 22:35:11 +0000
committerrubenwardy <rw@rubenwardy.com>2019-01-09 22:35:11 +0000
commit5f7efd4f31133974af555425a129f978f30ae7e1 (patch)
tree9d2a39e30711e011cdf29beb6361b317a1f8e3ce
parent7d52931a204f5116591165be5e4d2ce7ebd1cde7 (diff)
downloadcheatdb-5f7efd4f31133974af555425a129f978f30ae7e1.tar.xz
Reduce README size
-rw-r--r--README.md48
1 files changed, 4 insertions, 44 deletions
diff --git a/README.md b/README.md
index 6a4f38c..e8cf5dc 100644
--- a/README.md
+++ b/README.md
@@ -1,57 +1,17 @@
# Content Database
-## Setup
+Content database for Minetest mods, games, and more.
-First create a Python virtual env:
-
- virtualenv env -ppython3
- source env/bin/activate
-
-then use pip:
-
- pip3 install -r requirements.txt
-
-### Development
-
-* Copy config.example.cfg to config.cfg
-* Fill SECRET_KEY and WTF_CSRF_SECRET_KEY in with a random string
-* Make a Github OAuth Client at <https://github.com/settings/developers>:
- * Homepage URL - `http://localhost:5000/`
- * Authorization callback URL - `http://localhost:5000/user/github/callback/`
-* Put client id and client secret in GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET
-* Setup the database: python3 setup.py
-
-
-## Running
-
-### Development
-
-You need to enter the virtual environment if you haven't yet in
-the current session:
-
- source env/bin/activate
-
-If you need to, reset the db like so:
-
- python3 setup.py -t
-
-Then run the server:
-
- ./rundebug.py
-
-Then view in your web browser: http://localhost:5000/
+Developed by rubenwardy, license GPLv3.0+.
## How-tos
-### Start celery worker
+Note: you should first read one of the guides on the [Github repo wiki](https://github.com/minetest/contentdb/wiki)
```sh
+# Run celery worker
FLASK_CONFIG=../config.cfg celery -A app.tasks.celery worker
-```
-### Create migration
-
-```sh
# if sqlite
python setup.py -t
rm db.sqlite && python setup.py -t && FLASK_CONFIG=../config.cfg FLASK_APP=app/__init__.py flask db stamp head