summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIonică Bizău <bizauionica@yahoo.com>2014-03-31 22:06:03 +0300
committerFedor Indutny <fedor@indutny.com>2014-07-01 16:28:50 +0400
commit02b8109c140bb5c9bcab0282ea19481f769cfce4 (patch)
tree52a4a364d2a35858b86ab03acf7cafd8f4d869fb /README.md
parent423725b34d80ad09d6ed47393cda2aa183814010 (diff)
downloadandroid-node-v8-02b8109c140bb5c9bcab0282ea19481f769cfce4.tar.gz
android-node-v8-02b8109c140bb5c9bcab0282ea19481f769cfce4.tar.bz2
android-node-v8-02b8109c140bb5c9bcab0282ea19481f769cfce4.zip
docs: highlight shell-codes in CONTRIBUTING.md
Signed-off-by: Fedor Indutny <fedor@indutny.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 38 insertions, 20 deletions
diff --git a/README.md b/README.md
index 8d7a6432c9..12cf275a58 100644
--- a/README.md
+++ b/README.md
@@ -12,26 +12,32 @@ Prerequisites (Unix only):
Unix/Macintosh:
- ./configure
- make
- make install
+```sh
+./configure
+make
+make install
+```
With libicu i18n support:
- svn checkout --force --revision 214189 \
- http://src.chromium.org/svn/trunk/deps/third_party/icu46 \
- deps/v8/third_party/icu46
- ./configure --with-icu-path=deps/v8/third_party/icu46/icu.gyp
- make
- make install
+```sh
+svn checkout --force --revision 214189 \
+ http://src.chromium.org/svn/trunk/deps/third_party/icu46 \
+ deps/v8/third_party/icu46
+./configure --with-icu-path=deps/v8/third_party/icu46/icu.gyp
+make
+make install
+```
If your python binary is in a non-standard location or has a
non-standard name, run the following instead:
- export PYTHON=/path/to/python
- $PYTHON ./configure
- make
- make install
+```sh
+export PYTHON=/path/to/python
+$PYTHON ./configure
+make
+make install
+```
Prerequisites (Windows only):
@@ -48,30 +54,42 @@ and OS X installers will prompt you for the location to install to.
The tarballs are self-contained; you can extract them to a local directory
with:
- tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
+```sh
+tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz
+```
Or system-wide with:
- cd /usr/local && tar --strip-components 1 -xzf \
- /path/to/node-<version>-<platform>-<arch>.tar.gz
+```sh
+cd /usr/local && tar --strip-components 1 -xzf \
+ /path/to/node-<version>-<platform>-<arch>.tar.gz
+```
### To run the tests:
Unix/Macintosh:
- make test
+```sh
+make test
+```
Windows:
- vcbuild test
+```sh
+vcbuild test
+```
### To build the documentation:
- make doc
+```sh
+make doc
+```
### To read the documentation:
- man doc/node.1
+```sh
+man doc/node.1
+```
Resources for Newcomers
---