diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..49798fa69487d32a6df4d380435513d0af9e1227 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# Install and run mods + +You need to first install [node.js](https://docs.npmjs.com/getting-started/installing-node). + +Install the [http-server](https://www.npmjs.com/package/http-server) npm package. Including '-g' sets the installs the package gloabally, allowing you to use it as a command line tool: + +<code>npm install http-server -g</code> + +Clone the mods repository: + +<code>git clone ssh://git@gitlab.cba.mit.edu:846/pub/mods.git</code> + +Use the command line to navigate to the root of the mods repository: + +<code>cd mods</code> + +Start up a server: + +<code>http-server</code> + +Open a browser tab and go to <code>127.0.0.1:8080</code> which is the same as <code>http://localhost:8080</code> to view the server that you just started. + +Depending on how to need to use mods you can start local servers located in <code>mods/js</code>, for example, if you start from the root of the mods repository: + +<code>cd js</code> + +<code>node printserver.js</code> + + + +