-Cura\r
-====\r
+IMPORTANT: The definitive location for Aleph Object's Cura source code is here: https://code.alephobjects.com/diffusion/CURA\r
\r
-Read this, it's important!\r
-===========================\r
\r
-This is the development version of Cura for LulzBot 3D Printers by Aleph Objects, Inc. It is available here:\r
-https://github.com/alephobjects/Cura\r
+= Cura =\r
\r
-This branch is based on the upstream version maintained by daid and Ultimaker:\r
-https://github.com/daid/Cura\r
+This is the development version of Cura for LulzBot 3D Printers by Aleph Objects, Inc. It is available here: https://code.alephobjects.com/diffusion/CURA\r
\r
+This branch is based on the upstream version maintained by daid and Ultimaker: https://github.com/daid/Cura\r
\r
-Development\r
-===========\r
+= Development =\r
\r
-Cura is developed in Python with a C++ engine. The part you are looking at right now is the Python GUI.\r
-The C++ engine is responsible for generating the actual toolpath. For development of the engine check out https://github.com/Ultimaker/CuraEngine\r
+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://code.alephobjects.com/diffusion/CE/\r
\r
-Issues\r
-===========\r
+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.\r
\r
-Before posting issues (either Bugs, Feature requests or Requests for information) please read our policies carefully. These will be regulary updated and can be found at https://github.com/daid/Cura/wiki/Issue-policies\r
+There are two options to run cura on your system. Package (Build/install/run) or run directly from the source code.\r
\r
+== Running from Source ==\r
+Recommended for alpha testers and software developers contributing patches or pull requests.\r
\r
-Packaging\r
----------\r
+## Get the source code\r
+ git clone https://code.alephobjects.com/diffusion/CURA/cura.git\r
\r
-Cura development comes with a script "package.sh", this script has been designed to run under *nix OSes (Linux, MacOS, FreeBSD). For Windows the package.sh script can be run from bash using git.\r
-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.\r
+##Install dependencies for your platform\r
+Run the `sudo apt-get install ...` or `sudo yum install ...` line from the below platform dependant sections.\r
\r
-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.\r
+##Build CuraEngine\r
+Easily done by running package.sh once\r
+```\r
+cd cura\r
+package.sh <platform name here>\r
+```\r
+\r
+##Link CuraEngine\r
+For *nix OSes you can create a symbolic link. This can be placed in the directory above where you cloned cura.\r
+```\r
+cd ..\r
+ln -s ./cura/CuraEngine/build/CuraEngine CuraEngine\r
+```\r
+\r
+##Run\r
+``` ./dev-cura ```\r
\r
-Fedora\r
---------\r
+== Packaging ==\r
+Recommended for organizations that are building their own version of Cura.\r
\r
-Fedora builds Cura by using ```mock```, thereby enabling it to build RPMs for\r
-every distribution that ```mock``` has a configuration file for. In pratice\r
-this means that Fedora can build RPMs for several versions of Fedora, CentOS\r
-and RHEL.\r
+Cura development comes with a script "package.sh", this script has been designed to run under *nix OSes (Linux, MacOS, FreeBSD). 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.\r
\r
-Cura can be built under a regular user account, there is no need to have root\r
-privileges. In fact, having root privileges is very much discouraged.\r
\r
-However, the user account under which the build is performed needs to be a\r
-member of the 'mock' group. This is accomplished as follows:\r
+== Fedora ==\r
\r
+Fedora builds Cura by using `mock`, thereby enabling it to build RPMs for every distribution that `mock` has a configuration file for. In pratice this means that Fedora can build RPMs for several versions of Fedora, CentOS and RHEL. Cura can be built under a regular user account, there is no need to have root privileges. In fact, having root privileges is very much discouraged. However, the user account under which the build is performed needs to be a member of the 'mock' group. This is accomplished as follows:\r
```bash\r
sudo usermod -a -G mock "$(whoami)"\r
```\r
\r
-To install the software that is required to build Cura, run the following\r
-commands:\r
-\r
+To install the software that is required to build Cura, run the following commands:\r
```bash\r
sudo yum install -y git rpmdevtools rpm-build mock arduino\r
\r
\r
```bash\r
# Get the Cura software, only required once\r
-git clone https://github.com/daid/Cura.git Cura\r
+git clone https://code.alephobjects.com/diffusion/CURA/cura.git\r
\r
# Build for the current system\r
-cd Cura\r
+cd cura\r
./package.sh fedora\r
\r
# Install on the current system\r
./package.sh fedora /etc/mock/fedora-21-x86_64.cfg /etc/mock/fedora-rawhide-i386.cfg\r
```\r
\r
-Debian and Ubuntu Linux\r
---------\r
+== Debian and Ubuntu Linux ==\r
\r
To build and install Cura, run the following commands:\r
\r
```bash\r
-git clone https://github.com/daid/Cura.git\r
+git clone https://code.alephobjects.com/diffusion/CURA/cura.git\r
\r
-sudo apt-get install python-opengl\r
-sudo apt-get install python-numpy\r
-sudo apt-get install python-serial\r
-sudo apt-get install python-setuptools\r
-sudo apt-get install curl\r
+sudo apt-get install python-opengl python-numpy python-serial python-setuptools python-wxgtk3.0 curl python-power\r
# Run this also if you're building for 32bit Debian\r
-sudo apt-get install gcc-multilib g++-4.7-multilib\r
+sudo apt-get install gcc-multilib g++-multilib\r
\r
-cd Cura\r
+cd cura\r
\r
-sudo ./package.sh debian_amd64 # or debian_i386 for 32bit\r
+./package.sh debian_amd64 # or debian_i386 for 32bit\r
+# this will prompt for your root password to run dpkg-deb\r
\r
sudo dpkg -i ./scripts/linux/cura*.deb\r
```\r
\r
-Mac OS X\r
---------\r
-The following section describes how to prepare working environment for developing and packaing for Mac OS X.\r
-The working environment consist of build of Python, build of wxPython and all required Python packages.\r
+== FreeBSD ==\r
+\r
+On FreeBSD simply use the Port Tree (`cd /usr/ports/cad/cura`) to create (`make package`) and install (`make install`) the package as root. Port will check for all necessary dependencies. You can also use the provided binary package with `pkg install Cura`. If you want to create an archive for local use the `package.sh freebsd` script (as an ordinary user) will give you a tarball with the program.\r
+\r
+== Mac OS X ==\r
+\r
+The following section describes how to prepare working environment for developing and packaing for Mac OS X. The working environment consist of build of Python, build of wxPython and all required Python packages.\r
\r
We assume you already have Apple hardware with [64bit processor](http://support.apple.com/kb/HT3696) and you are familiar with tools like [virtualenv](http://pypi.python.org/pypi/virtualenv), [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) and [pip](http://www.pip-installer.org/en/latest/). Also ensure you have modern compiler installed.\r
\r
\r
-###Install Python\r
+##Install Python\r
You'll need **non-system**, **framework-based**, **universal** with **deployment target set to 10.6** build of Python 2.7\r
\r
**non-system**: Output of\r
-`python -c "import sys; print sys.prefix"`\r
+```python -c "import sys; print sys.prefix"```\r
should *not* start with *"/System/Library/Frameworks/Python.framework/"*.\r
\r
**framework-based**: Output of\r
-`python -c "import distutils.sysconfig as c; print(c.get_config_var('PYTHONFRAMEWORK'))"`\r
+```python -c "import distutils.sysconfig as c; print(c.get_config_var('PYTHONFRAMEWORK'))"```\r
should be non-empty string. E.g. *Python*.\r
\r
**universal**: Output of\r
-``lipo -info `which python` ``\r
+```lipo -info `which python` ```\r
should include both i386 and x86_64. E.g *"Architectures in the fat file: /usr/local/bin/python are: i386 x86_64"*.\r
\r
**deployment target set to 10.6**: Output of\r
-``otool -l `which python` ``\r
+```otool -l `which python` ```\r
should contain *"cmd LC_VERSION_MIN_MACOSX ... version 10.6"*.\r
\r
The easiest way to install it is via [Homebrew](http://mxcl.github.com/homebrew/) using the formula from Cura's repo:\r
-`brew install --build-bottle --fresh Cura/scripts/darwin/python.rb --universal`\r
+`brew install --build-bottle --fresh cura/scripts/darwin/python.rb --universal`\r
Note if you already have Python installed via Homebrew, you have to uninstall it first.\r
\r
You can also install [official build](http://www.python.org/ftp/python/2.7.3/python-2.7.3-macosx10.6.dmg).\r
\r
-\r
-FreeBSD\r
---------\r
-On FreeBSD simply use the Port Tree (`cd /usr/ports/cad/cura`) to create (`make package`) and install (`make install`) the package as root. Port will check for all necessary dependencies. You can also use the provided binary package with `pkg install Cura`.\r
-\r
-If you want to create an archive for local use the `package.sh freebsd` script (as an ordinary user) will give you a tarball with the program.\r
-\r
-\r
-###Configure Virtualenv\r
+##Configure Virtualenv\r
Create new virtualenv. If you have [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/) installed:\r
`mkvirtualenv Cura`\r
\r
\r
Assuming you have virtualenv at *~/.virtualenvs/Cura/* and [wxPython sources](http://sourceforge.net/projects/wxpython/files/wxPython/2.9.4.0/wxPython-src-2.9.4.0.tar.bz2) at *~/Downloads/wxPython-src-2.9.4.0/*:\r
\r
-1. `cd` into *~/Downloads/wxPython-src-2.9.4.0/* and configure the sources:\r
+1. ```cd``` into *~/Downloads/wxPython-src-2.9.4.0/* and configure the sources:\r
\r
./configure \\r
CFLAGS='-msse2 -mno-sse3 -mno-sse4' \\r
--with-osx_cocoa \\r
--with-zlib=builtin\r
\r
-2. `make install`\r
+2. ```make install```\r
Note to speedup the process I recommend you to enable multicore build by adding the -j*cores* flag:\r
- `make -j4 install`\r
-3. `cd` into *~/Downloads/wxPython-src-2.9.4.0/wxPython/*\r
+ ```make -j4 install```\r
+3. ```cd``` into *~/Downloads/wxPython-src-2.9.4.0/wxPython/*\r
4. Build wxPython (Note `python` is the python of your virtualenv):\r
\r
python setup.py build_ext \\r
WX_CONFIG=$HOME/.virtualenvs/Cura/bin/wx-config \\r
WXPORT=osx_cocoa\r
\r
-5. Install wxPython (Note `python` is the python of your virtualenv):\r
+5. Install wxPython (Note ```python``` is the python of your virtualenv):\r
\r
python setup.py install \\r
--prefix=$HOME/.virtualenvs/Cura \\r
Remember to use `python` for pacakging and `pythonw` to run app for debugging.\r
\r
\r
-###Install Python Packages\r
+##Install Python Packages\r
Required python packages are specified in *requirements.txt* and *requirements_darwin.txt*\r
-If you use virtualenv, installing requirements as easy as `pip install -r requirements_darwin.txt`\r
+If you use virtualenv, installing requirements as easy as ```pip install -r requirements_darwin.txt```\r
\r
\r
-###Package Cura into application\r
-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:\r
-`./package.sh darwin`\r
+##Package Cura into application\r
+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:\r
+```./package.sh darwin```\r
\r
Note that application is only guaranteed to work on Mac OS X version used to build and higher, but may not support lower versions.\r
E.g. Cura built on 10.8 will work on 10.8 and 10.7, but not on 10.6. In other hand, Cura built on 10.6 will work on 10.6, 10.7 and 10.8.\r
~ianmdlvl / cura.git / blobdiff