aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7cf27c5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Content Database
+
+## Setup
+
+First create a Python virtual env:
+
+ virtualenv env
+ source env/bin/activate
+
+then use pip:
+
+ pip install -r requirements.txt
+
+## Running
+
+You need to enter the virtual environment if you haven't yet in
+the current session:
+
+ source env/bin/activate
+
+Reset the database like so:
+
+ python setup.py -d
+
+Then run the server:
+
+ python rundebug.py
+
+Then view in your web browser:
+
+ http://localhost:5000/