gecko-dev/servo
Josh Matthews 5546b54e9e servo: Merge #4635 - Use latest mozjs (from jdm:updatemozjs); r=jdm
Source-Repo: https://github.com/servo/servo
Source-Revision: ddf77a1cff3b55cf316fa08164e2bb262b618d02
2015-01-14 16:24:46 -07:00
..
components servo: Merge #4635 - Use latest mozjs (from jdm:updatemozjs); r=jdm 2015-01-14 16:24:46 -07:00
etc servo: Merge #4142 - Have `mach doc` copy Rust docs, add `mach browse-doc` (from SimonSapin:refactor-doc); r=Manishearth 2014-12-03 16:27:56 -07:00
ports servo: Merge #4635 - Use latest mozjs (from jdm:updatemozjs); r=jdm 2015-01-14 16:24:46 -07:00
python servo: Merge #4581 - Update android openssl version due to security advisory https://www.openssl.org/news/secadv_20150108.txt (from glennw:openssl-update); r=larsbergstrom 2015-01-08 17:15:50 -07:00
resources servo: Merge #4358 - compositing: Implement `cursor` per CSS3-UI § 8.1.1 in the CEF/Mac port (from pcwalton:cursor); r=mbrubeck 2014-12-18 00:24:49 -07:00
support servo: Merge #4570 - Fix Android warnings (from Manishearth:android-warn); r=jdm 2015-01-08 21:54:48 -07:00
tests servo: Merge #4594 - Implement most of the important WindowProxy traps (from evilpie:window-proxy); r=jdm 2015-01-12 09:45:47 -07:00
.gitignore servo: Merge #4300 - Update PowerMeasure.py post-cargoify (from servo:fix-power); r=Manishearth 2014-12-12 15:06:55 -07:00
CONTRIBUTING.md servo: Merge #2430 - Add a link to easy bugs (from Manishearth:patch-2); r=SimonSapin 2014-05-14 08:22:17 -04:00
Cargo.toml servo: Merge #4140 - Move the root Cargo.toml to components/servo, and warn when Cargo is run directly (from SimonSapin:no-root-cargo-toml); r=SimonSapin 2014-12-02 19:27:51 -07:00
Info.plist servo: Build an app bundle on OS X 2012-04-23 17:43:45 -07:00
LICENSE servo: Add license 2013-04-03 18:37:29 -07:00
ORGANIZATION.md servo: Merge #4491 - update description in ORGANIZATION.md (from yodalee:update-ORGANIZATION-description); r=jdm 2014-12-29 18:21:45 -07:00
README.md servo: Merge #4279 - Rename "render"/"rendering" to "paint"/"painting" (from saneyuki:rename); r=jdm 2014-12-08 10:28:10 -07:00
cargo-nightly-build servo: Merge #4438 - Update cargo nightly to get android cross compile fix. Also add stub tra (from glennw:android-fix-1); r=metajack 2014-12-18 17:01:10 -07:00
mach servo: Merge #3230 - Cargoify servo (from servo:cargoify) 2014-09-09 08:18:18 -06:00
rust-snapshot-hash servo: Merge #4554 - Update rustc to revision 2cfb5acb5a2751c759627377e602bac4f88f2d19 (from servo:rustup_20141221); r=jdm 2015-01-08 08:00:57 -07:00
servobuild.example servo: Merge #3930 - Issue #3804 : Allow enabling debug-mozjs from servobuild config (from fabricedesre:issue3804); r=jdm 2014-11-07 01:24:28 -07:00

README.md

The Servo Parallel Browser Project

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

Servo welcomes contribution from everyone. See CONTRIBUTING.md for help getting started.

Prerequisites

On OS X (homebrew):

brew install automake pkg-config python cmake
pip install virtualenv

On OS X (MacPorts):

sudo port install python27 py27-virtualenv cmake

On Debian-based Linuxes:

sudo apt-get install curl freeglut3-dev \
    libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \
    msttcorefonts gperf g++ cmake python-virtualenv \
    libssl-dev libbz2-dev

On Fedora:

sudo yum install curl freeglut-devel libtool gcc-c++ libXi-devel \
    freetype-devel mesa-libGL-devel glib2-devel libX11-devel libXrandr-devel gperf \
    fontconfig-devel cabextract ttmkfdir python python-virtualenv expat-devel \
    rpm-build openssl-devel cmake bzip2
pushd .
cd /tmp
wget http://corefonts.sourceforge.net/msttcorefonts-2.5-1.spec
rpmbuild -bb msttcorefonts-2.5-1.spec
sudo yum install $HOME/rpmbuild/RPMS/noarch/msttcorefonts-2.5-1.noarch.rpm
popd

On Arch Linux:

sudo pacman -S base-devel git python2 python2-virtualenv mesa ttf-font cmake bzip2

Cross-compilation for Android:

Pre-installed Android tools are needed. See wiki for details

The Rust compiler

Servo uses a snapshot Rust compiler to build itself. This is normally a specific revision of Rust upstream, but sometimes has a backported patch or two. If you'd like to know the snapshot revision of Rust which we use, see ./rust-snapshot-hash.

Building

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

Normal build

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

Building for Android target

git clone https://github.com/servo/servo
cd servo
ANDROID_TOOLCHAIN=/path/to/toolchain ANDROID_NDK=/path/to/ndk PATH=$PATH:/path/to/toolchain/bin ./mach build --android
cd ports/android
ANDROID_SDK=/path/to/sdk make install

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

cp servobuild.example .servobuild
# edit .servobuild

Running

Commandline Arguments

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

Keyboard Shortcuts

  • Ctrl-L opens a dialog to browse to a new URL (Mac only currently)
  • Ctrl-- zooms out
  • Ctrl-= zooms in
  • Backspace goes backwards in the history
  • Shift-Backspace goes forwards in the history
  • Esc exits servo

Developing

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