summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4e0e0b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# cortex
+
+### requirements
+
+* Node.js 6+
+* MySQL
+* Python 2.7
+* Tensorflow 1.2
+
+### installation
+
+```
+npm install
+npm install knex -g
+knex migrate:latest
+```
+
+### running the server
+
+```
+npm start
+```
+
+The server will be running on http://lvh.me:5858/ or whichever port is specified in `.env`
+