summaryrefslogtreecommitdiff
path: root/README.mediawiki
diff options
context:
space:
mode:
Diffstat (limited to 'README.mediawiki')
-rw-r--r--README.mediawiki28
1 files changed, 23 insertions, 5 deletions
diff --git a/README.mediawiki b/README.mediawiki
index 8121f2af..bc89bac6 100644
--- a/README.mediawiki
+++ b/README.mediawiki
@@ -1,14 +1,32 @@
-= About =
-Rhizi server
+= Rhizi =
+
+A collaborative editor for organizing, communicating, and analyzing data in graph form.
+
+A.K.A The spreadsheet of tomorrow
= Use =
+
Command line use documentation can be view with:
:$ python rhizi_server.py -h
-= Hacking =
-== Neo4J DB Management ==
+= Development =
+
+To update the css files you need [sass](http://sass-lang.com/)
+
+The build tool is [make](https://www.gnu.org/software/make/)
+
+To rebuild the css files issue make from the top level directory:
+
+ $ make
+
+ For dev mode(debbuging, manual file load) use `?debug=1` at end of URL: e.g. `file://rhizifolder/html.index?debug=1`
+
+== Neo4J DB management ==
+
* Use <code>$ neo4j-shell -file reset-db__single_link.cypher</code> to bring the DB to an empty state, excluding two nodes and a single link.
-== Running the Tests ==
+== Running server tests ==
+
Test code makes use of Python's unittest - run by invoking them with python,
or by creating a launch configuration in your IDE of choice.
+