servo: Merge #12880 - Added OS Links in Markdown (from Coder206:osReadMe); r=nox,Ms2ger
authorPatrick Trottier <patrick.arrow206@outlook.com>
Tue, 16 Aug 2016 19:16:55 -0500
changeset 388482 6f3d33839f4da2a318ae2556a55ab7e827de0dd6
parent 388481 cbf35bb355998dbfaedb916d5c57e09eb4892740
child 388483 a68157e4a9b415a325fa7a836ada621d17508bb8
push id1468
push userasasaki@mozilla.com
push dateMon, 05 Jun 2017 19:31:07 +0000
treeherdermozilla-release@0641fc6ee9d1 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersnox, Ms2ger
servo: Merge #12880 - Added OS Links in Markdown (from Coder206:osReadMe); r=nox,Ms2ger <!-- Please describe your changes on the following line: --> It is really an improvement to make room for a commit that links contributors to https://janitor.technology --- <!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: --> - [x] `./mach build -d` does not report any errors - [x] `./mach test-tidy` does not report any errors <!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. --> Source-Repo: https://github.com/servo/servo Source-Revision: 17df3c276b5ac56645e5acf3b09ae684d732631f
servo/README.md
--- a/servo/README.md
+++ b/servo/README.md
@@ -7,32 +7,40 @@ Servo is a prototype web browser engine 
 64bit OS X, 64bit Linux, and Android.
 
 Servo welcomes contribution from everyone.  See
 [`CONTRIBUTING.md`](CONTRIBUTING.md) and [`HACKING_QUICKSTART.md`](docs/HACKING_QUICKSTART.md)
 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
 brew link --force openssl
 ```
 
 If you get this error during the brew link step:
 ```sh
@@ -52,56 +60,53 @@ If you get this error:
 brew uninstall ffmpeg
 brew install ffmpeg --build-from-source
 ./mach clean
 ./mach build
 ```
 
 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 \
     libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \
     gperf g++ build-essential cmake virtualenv python-pip \
     libssl-dev libbz2-dev libosmesa6-dev libxmu6 libxmu-dev \
     libglu1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libdbus-1-dev \
     libavformat-dev
 ```
 If you are on **Ubuntu 14.04** and encountered errors on installing these dependencies involving `libcheese`, see [#6158](https://github.com/servo/servo/issues/6158) for a workaround.
 
 If `virtualenv` does not exist, try `python-virtualenv`.
 
-On Fedora:
+#### On Fedora
 
 ``` sh
 sudo dnf install curl freeglut-devel libtool gcc-c++ libXi-devel \
     freetype-devel mesa-libGL-devel mesa-libEGL-devel glib2-devel libX11-devel libXrandr-devel gperf \
     fontconfig-devel cabextract ttmkfdir python python-virtualenv python-pip expat-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 \
     media-libs/freetype media-libs/mesa dev-util/gperf \
     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.
 
 Install MSYS2 from [here](https://msys2.github.io/). After you have done so, open an MSYS shell
 window and update the core libraries and install new packages. The extra step at the end is to
 downgrate GCC to 5.4, as the GCC6 versions in mingw currently fail to compile some of our
 dependencies. We are upgrading to a gcc-free build on Windows as soon as possible:
@@ -126,17 +131,17 @@ are not compatible with our `mach` drive
 ```sh
 cd /mingw64/bin
 mv python2.exe python2-mingw64.exe
 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)
 
 ## The Rust compiler
 
 Servo's build system automatically downloads a Rust compiler to build itself.
 This is normally a specific revision of Rust upstream, but sometimes has a