chiark / gitweb /
README Formatting tweaks
authornickthetait <tait@alephobjects.com>
Wed, 21 Oct 2015 19:54:14 +0000 (13:54 -0600)
committernickthetait <tait@alephobjects.com>
Wed, 21 Oct 2015 19:54:14 +0000 (13:54 -0600)
README.md

index f74f0a67367cdf6ea2b8f326711cb968b517eef6..559fa85be400cccc2d26b245abceb4b762bdbe3b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -21,24 +21,24 @@ Recommended for alpha testers and software developers contributing patches or pu
 ## Get the source code\r
   git clone https://code.alephobjects.com/diffusion/CURA/cura.git\r
 \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
+##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
-#Build CuraEngine\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
+##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
+##Run\r
 ``` ./dev-cura ```\r
 \r
 == Packaging ==\r
@@ -49,19 +49,12 @@ Cura development comes with a script "package.sh", this script has been designed
 \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.\r
-\r
-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.\r
-\r
-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
-\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
@@ -116,9 +109,7 @@ sudo dpkg -i ./scripts/linux/cura*.deb
 \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
+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
@@ -127,7 +118,7 @@ The following section describes how to prepare working environment for developin
 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