Browse Source

doc: *.md formatting fixes in the top-level dir

Continuing what a58b48bc3b did for the
doc/ dir, this fixes some formatting issues in the *.md files that
are placed directly in the top-level directory.

README.md changes are excluded as they are covered by
https://github.com/nodejs/node/pull/7971

Refs: https://github.com/nodejs/node/pull/7637
PR-URL: https://github.com/nodejs/node/pull/7727
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
v6.x
Сковорода Никита Андреевич 9 years ago
committed by cjihrig
parent
commit
abd0bc0523
  1. 50
      BUILDING.md
  2. 4
      CONTRIBUTING.md

50
BUILDING.md

@ -28,7 +28,7 @@ On FreeBSD and OpenBSD, you may also need:
* libexecinfo (FreeBSD and OpenBSD only) * libexecinfo (FreeBSD and OpenBSD only)
```text ```console
$ ./configure $ ./configure
$ make $ make
$ [sudo] make install $ [sudo] make install
@ -37,7 +37,7 @@ $ [sudo] make install
If your Python binary is in a non-standard location or has a If your Python binary is in a non-standard location or has a
non-standard name, run the following instead: non-standard name, run the following instead:
```text ```console
$ export PYTHON=/path/to/python $ export PYTHON=/path/to/python
$ $PYTHON ./configure $ $PYTHON ./configure
$ make $ make
@ -46,13 +46,13 @@ $ [sudo] make install
To run the tests: To run the tests:
```text ```console
$ make test $ make test
``` ```
To run the native module tests: To run the native module tests:
```text ```console
$ make test-addons $ make test-addons
``` ```
@ -61,7 +61,7 @@ To run the npm test suite:
*note: to run the suite on node v4 or earlier you must first* *note: to run the suite on node v4 or earlier you must first*
*run `make install`* *run `make install`*
``` ```console
$ make test-npm $ make test-npm
``` ```
@ -69,13 +69,13 @@ To build the documentation:
This will build Node.js first (if necessary) and then use it to build the docs: This will build Node.js first (if necessary) and then use it to build the docs:
```text ```console
$ make doc $ make doc
``` ```
If you have an existing Node.js you can build just the docs with: If you have an existing Node.js you can build just the docs with:
```text ```console
$ NODE=node make doc-only $ NODE=node make doc-only
``` ```
@ -83,13 +83,13 @@ $ NODE=node make doc-only
To read the documentation: To read the documentation:
```text ```console
$ man doc/node.1 $ man doc/node.1
``` ```
To test if Node.js was built correctly: To test if Node.js was built correctly:
``` ```console
$ node -e "console.log('Hello from Node.js ' + process.version)" $ node -e "console.log('Hello from Node.js ' + process.version)"
``` ```
@ -107,19 +107,19 @@ Prerequisites:
[Git for Windows](http://git-scm.com/download/win) includes Git Bash [Git for Windows](http://git-scm.com/download/win) includes Git Bash
and tools which can be included in the global `PATH`. and tools which can be included in the global `PATH`.
```text ```console
> vcbuild nosign > vcbuild nosign
``` ```
To run the tests: To run the tests:
```text ```console
> vcbuild test > vcbuild test
``` ```
To test if Node.js was built correctly: To test if Node.js was built correctly:
```text ```console
> Release\node -e "console.log('Hello from Node.js', process.version)" > Release\node -e "console.log('Hello from Node.js', process.version)"
``` ```
@ -136,7 +136,7 @@ Be sure you have downloaded and extracted [Android NDK]
(https://developer.android.com/tools/sdk/ndk/index.html) (https://developer.android.com/tools/sdk/ndk/index.html)
before in a folder. Then run: before in a folder. Then run:
``` ```console
$ ./android-configure /path/to/your/android-ndk $ ./android-configure /path/to/your/android-ndk
$ make $ make
``` ```
@ -165,13 +165,13 @@ Node.js source does not include all locales.)
##### Unix / OS X: ##### Unix / OS X:
```text ```console
$ ./configure --with-intl=full-icu --download=all $ ./configure --with-intl=full-icu --download=all
``` ```
##### Windows: ##### Windows:
```text ```console
> vcbuild full-icu download-all > vcbuild full-icu download-all
``` ```
@ -182,19 +182,19 @@ The `Intl` object will not be available, nor some other APIs such as
##### Unix / OS X: ##### Unix / OS X:
```text ```console
$ ./configure --without-intl $ ./configure --without-intl
``` ```
##### Windows: ##### Windows:
```text ```console
> vcbuild without-intl > vcbuild without-intl
``` ```
#### Use existing installed ICU (Unix / OS X only): #### Use existing installed ICU (Unix / OS X only):
```text ```console
$ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu
``` ```
@ -210,14 +210,18 @@ Download the file named something like `icu4c-**##.#**-src.tgz` (or
##### Unix / OS X ##### Unix / OS X
```text From an already-unpacked ICU:
# from an already-unpacked ICU: ```console
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu
```
# from a local ICU tarball From a local ICU tarball:
```console
$ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz
```
# from a tarball URL From a tarball URL:
```console
$ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz
``` ```
@ -227,7 +231,7 @@ First unpack latest ICU to `deps/icu`
[icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`) [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`)
as `deps/icu` (You'll have: `deps/icu/source/...`) as `deps/icu` (You'll have: `deps/icu/source/...`)
```text ```console
> vcbuild full-icu > vcbuild full-icu
``` ```

4
CONTRIBUTING.md

@ -100,7 +100,7 @@ changed and why. Follow these guidelines when writing one:
A good commit log can look something like this: A good commit log can look something like this:
``` ```txt
subsystem: explaining the commit in one line subsystem: explaining the commit in one line
Body of commit message is a few lines of text, explaining things Body of commit message is a few lines of text, explaining things
@ -122,7 +122,7 @@ what subsystem (or subsystems) your changes touch.
If your patch fixes an open issue, you can add a reference to it at the end If your patch fixes an open issue, you can add a reference to it at the end
of the log. Use the `Fixes:` prefix and the full issue URL. For example: of the log. Use the `Fixes:` prefix and the full issue URL. For example:
``` ```txt
Fixes: https://github.com/nodejs/node/issues/1337 Fixes: https://github.com/nodejs/node/issues/1337
``` ```

Loading…
Cancel
Save