Set the new minimal-extrusion-before-retraction default.

[cura.git] / README.md

diff --git a/README.md b/README.md
index 04cb559fc41b8476362c2dfef3caa9aef324299a..28b5e7b50d0ac7a4d292d8dbd8924ad05e5086dc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,21 +1,44 @@
 Cura
 ====
 
-If you are reading this, then you are looking at the *development* version of Cura. If you just want to use Cura look at the following location: https://github.com/daid/Cura/wiki
+Read this, it's important!
+===========================
+
+If you are reading this, then you are looking at the *development* version of Cura. If you just want to use Cura, take a look at the following location: https://daid.github.com/Cura
 
 Development
 ===========
 
-Cura is developed in Python. Getting Cura up and running for development is not very difficult. If you copy the python and pypy from a release into your Cura development checkout then you can use Cura right away, just like you would with a release.
-For development with git, check the help on github. Pull requests is the fastest way to get changes into Cura.
-
+Cura is developed in Python with a C++ engine. The part you are looking at right now is the Python GUI.
+The C++ engine is responsible for generating the actual toolpath. For development of the engine check out https://github.com/Ultimaker/CuraEngine
 
 Packaging
 ---------
 
-Cura development comes with a script "package.sh", this script has been designed to run under unix like OSes (Linux, MacOS). Running it from sygwin is not a priority.
+Cura development comes with a script "package.sh", this script has been designed to run under *nix OSes (Linux, MacOS). For Windows the package.sh script can be run from bash using git.
 The "package.sh" script generates a final release package. You should not need it during development, unless you are changing the release process. If you want to distribute your own version of Cura, then the package.sh script will allow you to do that.
 
+Both MacOS and Linux require some extra instructions for development, as you need to prepare an environment. Look below at the proper section to see what is needed.
+
+Debian and Ubuntu Linux
+--------
+
+To build and install Cura, run the following commands:
+
+```bash
+git clone https://github.com/daid/Cura.git
+
+sudo apt-get install python-opengl
+sudo apt-get install python-numpy
+sudo apt-get install python-serial
+sudo apt-get install python-setuptools
+
+cd Cura
+
+sudo ./package.sh debian
+
+sudo dpkg -i ./scripts/linux/Cura*.deb
+```
 
 Mac OS X
 --------
@@ -45,9 +68,11 @@ should include both i386 and x86_64. E.g *"Architectures in the fat file: /usr/l
 should contain *"cmd LC_VERSION_MIN_MACOSX ... version 10.6"*.
 
 The easiest way to install it is via [Homebrew](http://mxcl.github.com/homebrew/) using the formula from Cura's repo:  
-`brew install --fresh Cura/scripts/darwin/python.rb --universal`  
+`brew install --build-bottle --fresh Cura/scripts/darwin/python.rb --universal`  
 Note if you already have Python installed via Homebrew, you have to uninstall it first.
 
+You can also install [official build](http://www.python.org/ftp/python/2.7.3/python-2.7.3-macosx10.6.dmg).
+
 
 ###Configure Virtualenv
 Create new virtualenv. If you have [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) installed:  
@@ -60,6 +85,8 @@ Assuming you have virtualenv at *~/.virtualenvs/Cura/* and [wxPython sources](ht
 1. `cd` into *~/Downloads/wxPython-src-2.9.4.0/* and configure the sources:
 
         ./configure \
+        CFLAGS='-msse2 -mno-sse3 -mno-sse4' \
+        CXXFLAGS='-msse2 -mno-sse3 -mno-sse4' \
         --disable-debug \
         --enable-clipboard \
         --enable-display \
@@ -72,7 +99,7 @@ Assuming you have virtualenv at *~/.virtualenvs/Cura/* and [wxPython sources](ht
         --enable-universal_binary=i386,x86_64 \
         --enable-webkit \
         --prefix=$HOME/.virtualenvs/Cura/ \
-        --with-expat
+        --with-expat \
         --with-libjpeg=builtin \
         --with-libpng=builtin \
         --with-libtiff=builtin \
@@ -124,13 +151,6 @@ Remember to use `python` for pacakging and `pythonw` to run app for debugging.
 Required python packages are specified in *requirements.txt* and *requirements_darwin.txt*  
 If you use virtualenv, installing requirements as easy as `pip install -r requirements_darwin.txt`
 
-At time of writing PyObjC 2.5 is not available via pip, so you have to install it manually (Note `python` is the python of your virtualenv):
-
-1. Download [PyObjC 2.5](https://bitbucket.org/ronaldoussoren/pyobjc/get/pyobjc-2.5.zip)
-2. Extract the archive and `cd` into the directory
-3. `python install.py` (Note `python` is the python of your virtualenv):
-    If build fails, try the same command one more time. It's known issue.
-
 
 ###Package Cura into application
 Ensure that virtualenv is activated, so `python` points to the python of your virtualenv (e.g. ~/.virtualenvs/Cura/bin/python).Use package.sh to build Cura: