diff --git a/octoprint/LICENSE b/LICENSE similarity index 100% rename from octoprint/LICENSE rename to LICENSE diff --git a/README.md b/README.md index 8c8bde6..ab587e4 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,3 @@ -Attention -========= - -OctoPrint -- formerly known as Printer WebUI -- will be migrated to a new repository location reflecting its new name on Saturday 26th 2013. It will then -be located at http://github.com/foosel/OctoPrint. Please be prepared to upgrade your links and remote refs. Sorry for the inconvenience. - OctoPrint ========= @@ -23,9 +17,10 @@ allows * optional: creation of timelapse recordings of the printjob via webcam stream (using e.g. MJPG-Streamer) -- currently two timelaspe methods are implemented, triggering a shot on z-layer change or every "n" seconds The intended usecase is to run OctoPrint on a single-board computer like the Raspberry Pi and a WiFi module, -connect the printer to the server and therefore create a WiFi-enabled 3D printer. +connect the printer to the server and therefore create a WiFi-enabled 3D printer. If you want to add a webcam for visual +monitoring and timelapse support, you'll need a **powered** USB hub. -If you want to add a webcam for visual monitoring and timelapse support, you'll need a **powered** USB hub. +OctoPrint is Free Software and released under the [GNU Affero General Public License V3](http://www.gnu.org/licenses/agpl.html). Dependencies ------------ @@ -128,19 +123,19 @@ listed in requirements.txt: cd ~ sudo apt-get install python-pip git - git clone https://github.com/foosel/PrinterWebUI.git - cd PrinterWebUI + git clone https://github.com/foosel/OctoPrint.git + cd OctoPrint sudo pip install -r requirements.txt You should then be able to start the OctoPrint server: - pi@raspberrypi ~/PrinterWebUI $ ./run + pi@raspberrypi ~/OctoPrint $ ./run * Running on http://0.0.0.0:5000/ If you also want webcam and timelapse support, you'll need to download and compile MJPG-Streamer: cd ~ - sudo apt-get install libjpeg8-dev imagemagick libav-tools + sudo apt-get install subversion libjpeg8-dev imagemagick libav-tools wget -Omjpg-streamer.tar.gz http://mjpg-streamer.svn.sourceforge.net/viewvc/mjpg-streamer/mjpg-streamer/?view=tar tar xfz mjpg-streamer.tar.gz cd mjpg-streamer @@ -200,4 +195,20 @@ I also want to thank [Janina Himmen](http://jhimmen.de/) for providing the kick- Why is it called OctoPrint and what's with the crystal ball in the logo? ------------------------------------------------------------------------ -It so happens that I needed a favicon and also OctoPrint's first name -- Printer WebUI -- simply lacked a certain coolness to it. So I asked The Internet(tm) for advise. After some brainstorming, the idea of a cute Octopus watching his print job remotely through a crystal ball was born... [or something like that](https://plus.google.com/u/0/106003970953341660077/posts/UmLD5mW8yBQ). \ No newline at end of file +It so happens that I needed a favicon and also OctoPrint's first name -- Printer WebUI -- simply lacked a certain coolness to it. So I asked The Internet(tm) for advise. After some brainstorming, the idea of a cute Octopus watching his print job remotely through a crystal ball was born... [or something like that](https://plus.google.com/u/0/106003970953341660077/posts/UmLD5mW8yBQ). + +What do I have to do after the rename from Printer WebUI to OctoPrint? +---------------------------------------------------------------------- + +If you did checkout OctoPrint from its previous location at https://github.com/foosel/PrinterWebUI.git, you'll have to +update your so-called remote references in git in order to make 'git pull' use the new repository location as origin. + +To do so you'll only need to execute the following command in your OctoPrint/PrinterWebUI folder: + + git remote set-url origin https://github.com/foosel/OctoPrint.git + +After that you might also want to rename your base directory (which probably still is called 'PrinterWebUI') to 'OctoPrint' +and delete the folder 'printer_webui' in your base folder (which stays there thanks to Python's compiled bytecode files +even after a rename of the Python package to 'octoprint'). + +After that you are set, the configuration files are migrated automatically :) \ No newline at end of file