Update documentation (#22)

* Update documentation * Update documentation with links
aplbrain · Feb 6, 2019 · d5c9513 · d5c9513
1 parent 9b998be
commit d5c9513
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 207 deletions.
diff --git a/Pipfile b/Pipfile
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/docs/Language-Spec.md b/docs/Language-Spec.md
@@ -1,43 +1,12 @@
-# v1.0 (October 23, 2018)
+# Current version: v2.1 (February 6, 2019)
 
-```
-S -> T
-T -> nERn   | TDT | c  | ε
-R -> >      | +   | ~  | ?
-E -> -      | !   | ?
-D -> ;      | \n
-n -> /\S+/
-c -> /\#.*/
-```
 
-For example, the following notates that nodes `α`, `β`, and `γ` form a triangle:
 
-```
-α -> β
-β -> γ
-γ -> α
-```
 
-This example demonstrates that `α`, `β`, `γ`, and `λ` form a directed 4-cycle with no diagonals:
 
-```
-# Directed 4-cycle:
-α -> β
-β -> γ
-γ -> λ
-λ -> α
-
-# No diagonals:
-α !> γ
-γ !> α
-β !> λ
-λ !> β
-```
-
-Note that comments, prefixed with a `#` character, are valid syntax.
+# Older versions
 
-
-# v2.0 (Under Development)
+## v2.0
 
 ```
 // See Extended Backus-Naur Form for more details.
@@ -167,3 +136,41 @@ unidirectionalTriangle(x, y, z) {
 unidirectionalTriangle(A, B, C)
 unidirectionalTriangle(C, D, E)
 ```
+
+## v1.0 (October 23, 2018)
+
+```
+S -> T
+T -> nERn   | TDT | c  | ε
+R -> >      | +   | ~  | ?
+E -> -      | !   | ?
+D -> ;      | \n
+n -> /\S+/
+c -> /\#.*/
+```
+
+For example, the following notates that nodes `α`, `β`, and `γ` form a triangle:
+
+```
+α -> β
+β -> γ
+γ -> α
+```
+
+This example demonstrates that `α`, `β`, `γ`, and `λ` form a directed 4-cycle with no diagonals:
+
+```
+# Directed 4-cycle:
+α -> β
+β -> γ
+γ -> λ
+λ -> α
+
+# No diagonals:
+α !> γ
+γ !> α
+β !> λ
+λ !> β
+```
+
+Note that comments, prefixed with a `#` character, are valid syntax.
diff --git a/docs/README.md b/docs/README.md
@@ -3,3 +3,4 @@
 * [Installing dotmotif](installation)
 * [Getting started](start)
 * [Usage](usage)
+* [Constraints](attributes)
diff --git a/docs/installation.md b/docs/installation.md
@@ -6,9 +6,9 @@ git clone https://https://github.com/aplbrain/dotmotif/
 cd dotmotif
 ```
 
-You can most easily install dotmotif with pipenv:
+You can most easily install dotmotif with pip:
 
 ```shell
-pipenv install
+pip3 install -U .
 ```
 
diff --git a/docs/start.md b/docs/start.md
@@ -166,3 +166,5 @@ dotmotif.dotmotif(validators=[]).from_motif(m)
 ```
 
 This empty list overrides the default list of validators, which includes a built-in `DisagreeingEdgesValidator`. It's not recommended that you do this — but it is _possible_.
+
+Learn more about motif constraints [here](attributes.md).
diff --git a/docs/usage.md b/docs/usage.md
@@ -56,13 +56,4 @@ You can chain the entire operation into one single command using the chaining fu
 dm = dotmotif().from_motif("threecycle.motif").to_cypher()
 ```
 
-----
-
-```
-docker run -e NEO4J_AUTH=neo4j1/neo4j1 -p 7474:7474 -p 7687:7687 -v $(pwd)/import:/_import_csv --volume=$(pwd)/data:/data neo4j:3.4 /bin/bash
-
-docker run -e NEO4J_AUTH=neo4j1/neo4j1 -p 7474:7474 -p 7687:7687 -v $(pwd)/import:/_import_csv neo4j:3.4 /bin/bash
-
-./bin/neo4j-admin import --id-type STRING --nodes:Neuron /_import_csv/neurons.csv --relationships:SYN /_import_csv/synapses.csv && neo4j start
-
-```
+Learn more about motif constraints [here](attributes.md).