servo: Merge #19628 - add note on readme (from tigercosmos:x3); r=KiChjang
authortigercosmos <phy.tiger@gmail.com>
Mon, 25 Dec 2017 15:08:39 -0600
changeset 714627 834cde6951eed5b427245699f63219a073d1724d
parent 714593 68d6c3cb89ebf55c964eace44ba82ba14f06a3b9
child 714628 67104a1227e43cee6ff365eff7a3cf7142af5138
push id93978
push userbmo:bpostelnicu@mozilla.com
push dateWed, 27 Dec 2017 11:35:02 +0000
reviewersKiChjang
milestone59.0a1
servo: Merge #19628 - add note on readme (from tigercosmos:x3); r=KiChjang <!-- Please describe your changes on the following line: --> Add note about how to use command while running servo origin `readme` is not clear. I think ./mach run [url] [arguments] is more clear than ./mach run [url] --- <!-- 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 - [ ] These changes fix #__ (github issue number if applicable). <!-- Either: --> - [ ] There are tests for these changes OR - [ ] These changes do not require tests because _____ <!-- Also, please make sure that "Allow edits from maintainers" checkbox is checked, so that we can help you if you get stuck somewhere along the way.--> <!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. --> Source-Repo: https://github.com/servo/servo Source-Revision: 97bba5fdc16b4902df4280ec27682a0fa160bc41
servo/README.md
--- a/servo/README.md
+++ b/servo/README.md
@@ -225,19 +225,23 @@ to the Android SDK/NDK tools:
 
 ```
 cp servobuild.example .servobuild
 # edit .servobuild
 ```
 
 ## Running
 
-Use `./mach run [url]` to run Servo. Like so,
+Run Servo with the command:
 
-``` shell
+```sh
+./servo [url] [arguments] # if you run with nightly build
+./mach run [url] [arguments] # if you run with mach
+
+# For example
 ./mach run https://www.google.com
 ```
 
 Also, don't miss the info on the [browserhtml page](https://github.com/browserhtml/browserhtml) on how to run the Browser.html
 full tech demo (it provides a more browser-like experience than just browsing a single
 URL with servo).