chiark / gitweb /
Merge tag '15.01-RC8' into upstream
[cura.git] / README.md
index 75ed4c2030a71caead7952bb9c587db72d10741f..260ad1f7d9eb89244215ab1361595c41191c4030 100644 (file)
--- a/README.md
+++ b/README.md
@@ -31,6 +31,60 @@ The "package.sh" script generates a final release package. You should not need i
 \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
+Fedora\r
+--------\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
+\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
+\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
+```bash\r
+sudo yum install -y git rpmdevtools rpm-build mock arduino\r
+\r
+# Ensure that the Arduino tools can be found by the build\r
+sudo mkdir -p /usr/share/arduino/hardware/tools/avr\r
+sudo ln -sf /usr/bin /usr/share/arduino/hardware/tools/avr/bin\r
+\r
+```\r
+\r
+To build and install Cura, run the following commands:\r
+\r
+```bash\r
+# Get the Cura software, only required once\r
+git clone https://github.com/daid/Cura.git Cura\r
+\r
+# Build for the current system\r
+cd Cura\r
+./package.sh fedora\r
+\r
+# Install on the current system\r
+sudo yum localinstall -y scripts/linux/fedora/RPMS/Cura-*.rpm\r
+```\r
+\r
+Examples of building other configurations:\r
+\r
+```bash\r
+# Build for Fedora rawhide x86-64 and i386\r
+./package.sh fedora fedora-rawhide-x86_64.cfg fedora-rawhide-i386.cfg\r
+\r
+# Since only the basename of the mock configurations is used, this also works:\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
 \r