Repository files navigation

Servo is a prototype web browser engine written in theRust language. It is currently developed on64bit OS X, 64bit Linux, and Android.

Servo welcomes contribution from everyone. SeeCONTRIBUTING.md andHACKING_QUICKSTART.mdfor help getting started.

Visit theServo Project page for news and guides.

Please select your operating system:

• OS X
• Debian-based Linuxes
• Fedora
• Arch Linux
• openSUSE
• Gentoo Linux
• Microsoft Windows (MSVC)
• Microsoft Windows (mingw)
• Android

brew install automake pkg-config python cmake yasmpip install virtualenv

sudo port install python27 py27-virtualenv cmake yasm

brew install opensslexport OPENSSL_INCLUDE_DIR="$(brew --prefix openssl)/include"export OPENSSL_LIB_DIR="$(brew --prefix openssl)/lib"./mach build ...

If you've already partially compiled servo but forgot to do this step, run./mach clean, set the shell variables, and recompile.

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

If you are onUbuntu 14.04 and encountered errors on installing these dependencies involvinglibcheese, see#6158 for a workaround.

Ifvirtualenv does not exist, trypython-virtualenv.

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

sudo zypper install libX11-devel libexpat-devel libbz2-devel Mesa-libEGL-devel Mesa-libGL-devel cabextract cmake \    dbus-1-devel fontconfig-devel freetype-devel gcc-c++ git glib2-devel gperf \    harfbuzz-devel libOSMesa-devel libXcursor-devel libXi-devel libXmu-devel libXrandr-devel libopenssl-devel \    python-pip python-virtualenv rpm-build glu-devel

sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake bzip2 libxmu glu pkg-config

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

Install Git for Windows (https://git-scm.com/download/win). DO allow it to add git.exe to the PATH (defaultsettings for the installer are fine).

Install Visual Studio 2015 Community Edition (https://www.visualstudio.com/). You MUST add "Visual C++" to thelist of installed components. It is not on by default.

Install Python for Windows (https://www.python.org/downloads/release/python-2711/). The windows x86-64 MSI installer is fine.You should change the installation to install the "Add python.exe to Path" feature.

Install virtualenv.

In a normal Windows Shell (cmd.exe or "Command Prompt" from the start menu), do:

pip install virtualenv

If this does not work, you may need to reboot for the changed PATH settings (by the python installer) to take effect.

Download Python for Windowshere. This isrequired for the SpiderMonkey build on Windows.

Install MSYS2 fromhere. After you have done so, open an MSYS shellwindow and update the core libraries and install new packages. The extra step at the end is todowngrade GCC to 5.4, as the GCC6 versions in mingw currently fail to compile some of ourdependencies. We are upgrading to a gcc-free build on Windows as soon as possible:

pacman -Supacman -Sy git mingw-w64-x86_64-toolchain mingw-w64-x86_64-freetype \    mingw-w64-x86_64-icu mingw-w64-x86_64-nspr mingw-w64-x86_64-ca-certificates \    mingw-w64-x86_64-expat mingw-w64-x86_64-cmake tar diffutils patch \    patchutils make python2-setuptoolsexport GCC_URL=http://repo.msys2.org/mingw/x86_64/mingw-w64-x86_64-gccexport GCC_EXT=5.4.0-1-any.pkg.tar.xzpacman -U --noconfirm$GCC_URL-$GCC_EXT$GCC_URL-ada-$GCC_EXT \$GCC_URL-fortran-$GCC_EXT$GCC_URL-libgfortran-$GCC_EXT$GCC_URL-libs-$GCC_EXT \$GCC_URL-objc-$GCC_EXTeasy_install-2.7 pip virtualenv

Add the following line to the end of.profile in your home directory:

export PATH=/c/Python27:$PATH

Now, open a MINGW64 (not MSYS!) shell window, and you should be able to buildservo as usual!

Pre-installed Android tools are needed. See wiki fordetails

Servo's build system automatically downloads a Rust compiler to build itself.This is normally a specific revision of Rust upstream, but sometimes has abackported patch or two.If you'd like to know which nightly build of Rust we use, seerust-nightly-date.

Servo is built with Cargo, the Rust package manager. We also use Mozilla'sMach tools to orchestrate the build and other tasks.

To build Servo in development mode. This is useful for development, butthe resulting binary is very slow.

git clone https://github.com/servo/servocd servo./mach build --dev./mach run tests/html/about-mozilla.html

Or on Windows MSVC, in a normal Command Prompt (cmd.exe):

git clone https://github.com/servo/servocd servomach.bat build --dev

For benchmarking, performance testing, orreal-world use, add the--release flag to create an optimized build:

./mach build --release./mach run --release tests/html/about-mozilla.html

git clone https://github.com/servo/servocd servoexport ANDROID_SDK="/path/to/sdk"export ANDROID_NDK="/path/to/ndk"export ANDROID_TOOLCHAIN="/path/to/toolchain"export PATH="$PATH:/path/to/toolchain/bin"./mach build --release --android./mach package --release --android

Rather than setting theANDROID_* environment variables every time, you canalso create a.servobuild file and then edit it to contain the correct pathsto the Android SDK/NDK tools:

cp servobuild.example .servobuild# edit .servobuild

Use./mach run [url] to run Servo. Also, don't miss the info on thebrowserhtml page on how to run the Browser.htmlfull tech demo (it provides a more browser-like experience than just browsing a singleURL with servo).

• -p INTERVAL turns on the profiler and dumps info to the console everyINTERVAL seconds
• -s SIZE sets the tile size for painting; defaults to 512
• -z disables all graphical output; useful for running JS / layout tests
• -Z help displays useful output to debug servo

• Ctrl+- zooms out
• Ctrl+= zooms in
• Alt+left arrow goes backwards in the history
• Alt+right arrow goes forwards in the history
• Esc exits servo

There are lots of mach commands you can use. You can list them with./mach --help.

The generated documentation can be found onhttp://doc.servo.org/servo/index.html