aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md35
1 files changed, 20 insertions, 15 deletions
diff --git a/README.md b/README.md
index cba4907649e..9830932e4c7 100644
--- a/README.md
+++ b/README.md
@@ -12,22 +12,30 @@ for help getting started.
Visit the [Servo Project page](https://servo.org/) for news and guides.
-## Prerequisites
+## Setting up your environment
-On OS X (homebrew):
+Please select your operating system:
+* [OS X](#os-x)
+* [Debian-based Linuxes](#on-debian-based-linuxes)
+* [Fedora](#on-fedora)
+* [Arch Linux](#on-arch-linux)
+* [Gentoo Linux](#on-gentoo-linux)
+* [Microsoft Windows](#on-windows)
+* [Android](#cross-compilation-for-android)
+
+#### OS X
+#### On OS X (homebrew)
``` sh
brew install automake pkg-config python cmake ffmpeg
pip install virtualenv
```
-
-On OS X (MacPorts):
+#### On OS X (MacPorts)
``` sh
sudo port install python27 py27-virtualenv cmake ffmpeg
```
-
-On OS X 10.11 (El Capitan), you also have to install openssl:
+#### On OS X 10.11 (El Capitan), you also have to install openssl
``` sh
brew install openssl
@@ -57,7 +65,7 @@ brew install ffmpeg --build-from-source
If you've already partially compiled servo but forgot to do this step, run ./mach clean, link openssl, and recompile.
-On Debian-based Linuxes:
+#### On Debian-based Linuxes
``` sh
sudo apt-get install git curl freeglut3-dev autoconf \
@@ -71,7 +79,7 @@ If you are on **Ubuntu 14.04** and encountered errors on installing these depend
If `virtualenv` does not exist, try `python-virtualenv`.
-On Fedora:
+#### On Fedora
``` sh
sudo dnf install curl freeglut-devel libtool gcc-c++ libXi-devel \
@@ -80,14 +88,12 @@ sudo dnf install curl freeglut-devel libtool gcc-c++ libXi-devel \
rpm-build openssl-devel cmake bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \
dbus-devel ffmpeg-devel
```
-
-On Arch Linux:
+#### On Arch Linux
``` sh
sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake bzip2 libxmu glu pkg-config
```
-
-On Gentoo Linux:
+#### On Gentoo Linux
```sh
sudo emerge net-misc/curl media-libs/freeglut \
@@ -95,8 +101,7 @@ sudo emerge net-misc/curl media-libs/freeglut \
dev-python/virtualenv dev-python/pip dev-libs/openssl \
x11-libs/libXmu media-libs/glu x11-base/xorg-server
```
-
-On Windows:
+#### On Windows
Download Python for Windows [here](https://www.python.org/downloads/release/python-2711/). This is
required for the SpiderMonkey build on Windows.
@@ -131,7 +136,7 @@ mv python2.7.exe python2.7-mingw64.exe
Now, open a MINGW64 (not MSYS!) shell window, and you should be able to build servo as usual!
-Cross-compilation for Android:
+#### Cross-compilation for Android
Pre-installed Android tools are needed. See wiki for
[details](https://github.com/servo/servo/wiki/Building-for-Android)