Improve README

This commit is contained in:
Brian Anderson 2012-10-17 23:24:02 -07:00
parent c408fe16e0
commit 6bfa2254a0
2 changed files with 29 additions and 15 deletions

View file

@ -1,18 +1,21 @@
## The Servo Parallel Browser Project # The Servo Parallel Browser Project
Servo is a web browser engine written in the Rust language. It is Servo is a prototype web browser engine written in the [Rust]
currently developed on OS X and Linux. language. It is currently developed on OS X and Linux.
Note: Servo requires a bleeding-edge version of Rust. The Rust commit **Note:** Servo always requires a specific version of Rust - building
most recently tested is listed below. Servo often doesn't build against a released version of Rust will not work, nor will the Rust
against Rust _incoming_ or _master_ branches, due to upstream language 'master' branch. The commit below will *probably* work. If it does not
changes. If you want to unbreak Servo against the latest Rust build, then the topic in #servo might know better.
somebody in #servo or #rust will usually know what magic is required
to fix the build.
* Last known-good rust commit: 57b4d10ff652d3beddae64782c882a07822bac3c * Last known-good Rust commit: 57b4d10ff652d3beddae64782c882a07822bac3c
### Prerequisites [rust]: http://www.rust-lang.org
## Prerequisites
First, you need the Rust compiler, built from the exact commit listed
above.
On OS X (homebrew): On OS X (homebrew):
@ -27,19 +30,22 @@ On Debian-based Linuxes:
sudo apt-get install libcairo2-dev libpango1.0-dev autoconf2.13 freeglut3-dev sudo apt-get install libcairo2-dev libpango1.0-dev autoconf2.13 freeglut3-dev
### Building ## Building
git clone git://github.com/mozilla/servo.git git clone git://github.com/mozilla/servo.git
cd servo cd servo
mkdir -p build && cd build mkdir -p build && cd build
../configure ../configure
make check-servo && make make check-servo && make
./servo ../src/test/test.html ./servo ../src/test/hello.html
If `rustc` is not installed then add `RUSTC=/path/to/rustc` to your
`make` commands.
### Build Workarounds ## Build Workarounds
#### MacPorts ### MacPorts
Currently, the Makefile for the `rust-azure` submodule has hardcoded Currently, the Makefile for the `rust-azure` submodule has hardcoded
library paths that assumes cairo has been installed with homebrew or library paths that assumes cairo has been installed with homebrew or

8
src/test/hello.html Normal file
View file

@ -0,0 +1,8 @@
<!-- This test is used as an example in README.md. Don't rename without changing there too -->
<!DOCTYPE html>
<html>
<body>
<div>Hello, World!</div>
</body>
</html>