Skip to content

Commit

Permalink
docs: highlight shell-codes in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: Fedor Indutny <[email protected]>
  • Loading branch information
IonicaBizau authored and indutny committed Jul 1, 2014
1 parent 423725b commit 02b8109
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 26 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ through the process.
Fork the project [on GitHub](https://github.com/joyent/node) and check out
your copy.

```
```sh
$ git clone [email protected]:username/node.git
$ cd node
$ git remote add upstream git://github.com/joyent/node.git
Expand Down Expand Up @@ -48,7 +48,7 @@ does not align with that of a project maintainer.
Okay, so you have decided on the proper branch. Create a feature branch
and start hacking:

```
```sh
$ git checkout -b my-feature-branch -t origin/v0.10
```

Expand All @@ -59,7 +59,7 @@ $ git checkout -b my-feature-branch -t origin/v0.10

Make sure git knows your name and email address:

```
```sh
$ git config --global user.name "J. Random User"
$ git config --global user.email "[email protected]"
```
Expand Down Expand Up @@ -99,7 +99,7 @@ what subsystem (or subsystems) your changes touch.

Use `git rebase` (not `git merge`) to sync your work from time to time.

```
```sh
$ git fetch upstream
$ git rebase upstream/v0.10 # or upstream/master
```
Expand All @@ -111,7 +111,7 @@ Bug fixes and features should come with tests. Add your tests in the
test/simple/ directory. Look at other tests to see how they should be
structured (license boilerplate, common includes, etc.).

```
```sh
$ make jslint test
```

Expand All @@ -134,7 +134,7 @@ node ./test/simple/test-streams2-transform.js

### PUSH

```
```sh
$ git push origin my-feature-branch
```

Expand Down
58 changes: 38 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand All @@ -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
---
Expand Down

0 comments on commit 02b8109

Please sign in to comment.