gecko-dev/servo
Patrick Walton de5550d56e servo: Merge #3765 - util: Make some minor formatting cleanups to profiling and gfx (from pcwalton:profiler-cleanups); r=cgaebel
The only real user-visible change this effects is to trim URLs to 30 characters so they don't make huge lines on the terminal.

r? @cgaebel

Source-Repo: https://github.com/servo/servo
Source-Revision: a6f0159cb85e3b84a826c41ae5ad1b6aea09d7cc
2014-10-22 14:45:35 -06:00
..
.cargo servo: Merge #3230 - Cargoify servo (from servo:cargoify) 2014-09-09 08:18:18 -06:00
components servo: Merge #3765 - util: Make some minor formatting cleanups to profiling and gfx (from pcwalton:profiler-cleanups); r=cgaebel 2014-10-22 14:45:35 -06:00
etc servo: Merge #3487 - Upgrade Rust and enable style crate rustdoc (from servo:rustup-20140923); r=Ms2ger 2014-09-29 10:45:27 -06:00
ports servo: Merge #3765 - util: Make some minor formatting cleanups to profiling and gfx (from pcwalton:profiler-cleanups); r=cgaebel 2014-10-22 14:45:35 -06:00
python servo: Merge #3751 - Update toml.py to upstream 1069d2449760525535ca77514a92e9237ee0deaf (from fabricedesre:update-toml); r=metajack 2014-10-21 20:36:33 -06:00
resources servo: Merge #3622 - layout: Introduce support for legacy presentational attributes to selector matching, and use it for `<input size>` and `<td width>` (from pcwalton:html4ever); r=jdm 2014-10-14 14:06:36 -06:00
src servo: Merge #3730 - Introduce a basic shared task pool, and use it for image decoding (from glennw:taskpool); r=pcwalton 2014-10-21 15:15:42 -06:00
support/rust-task_info servo: Merge #3230 - Cargoify servo (from servo:cargoify) 2014-09-09 08:18:18 -06:00
tests servo: Merge #3752 - gfx: Switch the default to CPU painting (from pcwalton:default-cpu); r=larsbergstrom 2014-10-21 21:18:33 -06:00
.gitignore servo: Merge #3230 - Cargoify servo (from servo:cargoify) 2014-09-09 08:18:18 -06: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.lock servo: Merge #3749 - gfx: Update rust-azure to pick up arcs, gradients, and subpixel text (from pcwalton:update-rust-azure); r=metajack 2014-10-21 19:54:37 -06:00
Cargo.toml servo: Merge #3563 - Move windowing code out of compositor, take 2. r=larsberg (from mbrubeck:app2) 2014-10-10 13:12:37 -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 #3435 - Reorganize macros crate; r=jdm (from Manishearth:macro_reorg) 2014-09-23 17:54:37 +05:01
README.md servo: Merge #3767 - readme: Embiggen the name of the project (from pcwalton:readme-header) 2014-10-22 09:59:00 +09:00
mach servo: Merge #3230 - Cargoify servo (from servo:cargoify) 2014-09-09 08:18:18 -06:00
rust-snapshot-hash servo: Merge #3487 - Upgrade Rust and enable style crate rustdoc (from servo:rustup-20140923); r=Ms2ger 2014-09-29 10:45:27 -06:00
servobuild.example servo: Merge #3568 - Add Android build config to mach/servobuild (from mbrubeck:mach-android); r=metajack 2014-10-03 15:45:28 -06: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

Note, on systems without glfw3 packages, you can compile from source. An example can be found in the TravisCI install script.

On OS X (homebrew):

brew install automake pkg-config python glfw3 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 libglfw-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 glfw-devel cmake
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 glfw ttf-font cmake

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 rendering; 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.