From d1311df50598c5d3199be5054047cdda98817e19 Mon Sep 17 00:00:00 2001
From: palomagr <palomagr@mit.edu>
Date: Mon, 12 Nov 2018 13:16:12 -0500
Subject: [PATCH] Documentation and edits

---
 README.md                |  2 +-
 client/client.js         |  2 +-
 installing-node-sp-ws.md | 24 ++++++++++++++++++++----
 3 files changed, 22 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 367cf63..ba18aea 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ aka project 'consistent-sandbox'
 
 We aim to take an event graph architecture down through multiple layers of computing, routing event propagation also through a message passing network between multiple cpus each operating modular hardware endpoints.
 
-This project serves the developement environment / api we use to write and represent programs that are event graphs. 
+This project serves the developement environment / api we use to write and represent programs that are event graphs. [Install and Run](https://gitlab.cba.mit.edu/jakeread/atkapi/blob/master/installing-node-sp-ws.md)
 
 ![img moving](doc/images/mothermother.gif)
 
diff --git a/client/client.js b/client/client.js
index a0561d4..2c72cdc 100644
--- a/client/client.js
+++ b/client/client.js
@@ -160,7 +160,7 @@ function heapSendsNewProgram(prgm) {
     // whole hearted replace
     // hello for bugs when we lay this on top of something else 
     program = prgm
-    // 1st we want to git rm old shit ... 
+    // 1st we want to git rm old files ... 
     // when adding links, we'll have to add all and then draw links
     console.log(program)
     for (mdlName in program.modules) {
diff --git a/installing-node-sp-ws.md b/installing-node-sp-ws.md
index 779e248..a50f060 100644
--- a/installing-node-sp-ws.md
+++ b/installing-node-sp-ws.md
@@ -1,15 +1,17 @@
-# Installing Node.js, WebSocket and SerialPort
+# Installing Node.js, WebSocket and SerialPort | Run atkapi
 
-To interface over mods, or with atkterminal, you'll need to install node.js, and then the packages serialport and ws (websocket).
+To run atkapi you'll need to install node.js, and then the packages serialport and ws (websocket).
 
 ## Install Node.js
 
-Node.js is a runtime environment for javascript, so you can write and run js locally. [Download and install it here](https://nodejs.org/en/download/) - right now, I'm running v6.11.3, 8.11.3 should work as well. 
+Node.js is a runtime environment for javascript, so you can write and run js locally. [Download and install it here](https://nodejs.org/en/download/). 
 
 To check that node is installed, you can use
 
 ``node -v``
 
+In Windows check that in *Environment Variables, System Variables, Path* there is a path for C:\Users\yourusername\npm folder. If the folder does not exist, create it and set the path.  
+
 ## Install Serialport
 
 Node comes with a package controller called 'npm' - node package manager. You can use this to install dependencies for node programs. 
@@ -26,4 +28,18 @@ WebSockets are very simple web connections. In the *atkbridge* we use one to mov
 
 To install ws, do
 
-``npm install ws``
\ No newline at end of file
+``npm install ws``
+
+## Run atkapi (yay!)
+
+cd to the atkapi folder and run: 
+
+``node main``
+
+You should see this message in the terminal *OPENING THIS PRGRAM REP ...* 
+
+## Open local host
+
+In a browser open *localhost:8080* you will see the mods and this msg in the terminal *SEND PROGRAMS TO UI* 
+
+## Ready to play with atkapi. 
\ No newline at end of file
-- 
GitLab