aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbors-servo <lbergstrom+bors@mozilla.com>2016-07-20 21:23:18 -0500
committerGitHub <noreply@github.com>2016-07-20 21:23:18 -0500
commit20b1764d71a967ee4a355cd1b55e4250fe5f59a9 (patch)
tree61927b6001fea17262087eadfa6eb30d3eac8cb9
parentb34b30fd96e29f9c3773c9146c78e3d47fdc156d (diff)
parent3c854d084b87c9d1fd1377521c389065adc337b8 (diff)
downloadservo-20b1764d71a967ee4a355cd1b55e4250fe5f59a9.tar.gz
servo-20b1764d71a967ee4a355cd1b55e4250fe5f59a9.zip
Auto merge of #12514 - changm:issue12396, r=SimonSapin
Issue 12396 to add developer documentation to readme. <!-- Please describe your changes on the following line: --> Just some added developer documentation that was useful for me while starting to develop servo. This adds the documentation about running ./mach clean with a partially built servo but before linking openssl. It also adds the -Z flag under command line flags for debugging help. --- <!-- 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 - [ X] These changes fix #12396 (github issue number if applicable). <!-- Either: --> - [ ] There are tests for these changes OR - [X] These changes do not require tests because it is a documentation update only. <!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. --> <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/12514) <!-- Reviewable:end -->
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index fa9450c6263..00d8a650d71 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,8 @@ brew install openssl
brew link --force openssl
```
+If you've already partially compiled servo but forgot to do this step, run ./mach clean, link openssl, and recompile.
+
On Debian-based Linuxes:
``` sh
@@ -176,6 +178,7 @@ URL with servo).
`INTERVAL` 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
### Keyboard Shortcuts