From ce7aaa81d9825f2ecdf769d85bcf3105475cb18e Mon Sep 17 00:00:00 2001 From: quillford Date: Sat, 5 Dec 2015 21:54:41 -0800 Subject: [PATCH] added instructions to readme --- README.md | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b296997..9ec173e 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,38 @@ # Octofab A tool to turn the awesome Octoprint into a standalone independent application for use on Smoothieboards -# Using - -First clone this repository : +# Installing on Smoothie +* Copy ```index.html``` and the ```static``` folder to your smoothie's sd card +* [Enable the ethernet module](http://smoothieware.org/network) +* Connect the smoothieboard to ethernet +* Go to ```http://ip/sd/index.html``` in your browser, replace 'ip' with your board's IP address -git clone https://github.com/arthurwolf/Octofab.git - -Move to the new repository +# Using -cd Octofab/ +* First clone this repository: -In there, clone Octoprint itself +```git clone https://github.com/arthurwolf/Octofab.git``` -git clone https://github.com/foosel/OctoPrint.git +* Move to the new repository -Move to the OctoPrint folder: +```cd Octofab/``` -cd OctoPrint +* In there, clone OctoPrint itself -Create a user-owned virtual environment therein: +```git clone https://github.com/foosel/OctoPrint.git``` -virtualenv --system-site-packages venv +* Move to the OctoPrint folder: -Install OctoPrint into that virtual environment: +```cd OctoPrint``` -./venv/bin/python setup.py install +* Create a user-owned virtual environment therein: -Run Octoprint +```virtualenv --system-site-packages venv``` -./venv/bin/octoprint +* Install OctoPrint into that virtual environment: +```./venv/bin/python setup.py install``` +* Run OctoPrint +```./venv/bin/octoprint```