doc: fixed lint errors in README files

PR-URL: #440 Reviewed-By: Jack Horton <[email protected]> Reviewed-By: Jimmy Thomson <[email protected]>
nodejs · Nov 30, 2017 · a97f06e · a97f06e
1 parent ca720a3
commit a97f06e
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-Node.js on ChakraCore
-=====================
+# Node.js on ChakraCore
 
 This project enables Node.js to optionally use the [ChakraCore](https://github.com/Microsoft/ChakraCore)
 JavaScript engine. This project is still **work in progress** and not an officially
@@ -46,20 +45,20 @@ You can download and install stable prebuilt Node-ChakraCore from the
 _For installing Node-ChakraCore side-by-side your existing Node installation, we
 recommend [Node Version Switcher (NVS)](https://github.com/jasongin/nvs)._
 
-```
-nvs remote chakracore https://github.com/nodejs/node-chakracore/releases
-nvs add chakracore/latest
-nvs use chakracore
+```console
+$ nvs remote chakracore https://github.com/nodejs/node-chakracore/releases
+$ nvs add chakracore/latest
+$ nvs use chakracore
 ```
 
 Nightly builds of Node-ChakraCore are available at
 [https://nodejs.org/download/chakracore-nightly/](https://nodejs.org/download/chakracore-nightly/)
 Please use the following instructions to install the nightly builds.
 
-```
-nvs remote chakracore-nightly https://nodejs.org/download/chakracore-nightly/
-nvs add chakracore-nightly/latest
-nvs use chakracore-nightly
+```console
+$ nvs remote chakracore-nightly https://nodejs.org/download/chakracore-nightly/
+$ nvs add chakracore-nightly/latest
+$ nvs use chakracore-nightly
 ```
 
 ### Building Node-ChakraCore
@@ -74,19 +73,19 @@ Prerequisites:
 * [Visual Studio](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx)
 
 Build Command:
-```batch
+```console
 > vcbuild [x86|x64|arm]
 ```
 
 To run unit tests
 
-```batch
+```console
 > vcbuild nobuild test ignore-flaky [x86|x64|arm]
 ```
 
 To test if Node.js was built correctly with ChakraCore:
 
-```batch
+```console
 > node -e "console.log('Hello from Node.js ' + process.jsEngine)"
 Hello from Node.js chakracore
 ```
@@ -97,12 +96,12 @@ Install building tools and ChakraCore dependencies:
 Clang 3.7+ / CMake 3.2 are required
 
 Debian/Ubuntu:
-```
+```console
 $ sudo apt-get install -y build-essential cmake clang libicu-dev
 ```
 
 Fedora:
-```
+```console
 $ su
 $ dnf group install -y "Development Tools" "C Development Tools and Libraries"
 $ dnf install -y git cmake clang gcc gcc-c++ kernel-devel python llvm
@@ -111,26 +110,26 @@ $ dnf install -y lttng-ust-devel.x86_64 libicu-devel.x86_64 libstdc++-static.x86
 
 Clone this repo and check out **`master`** branch:
 
-```
+```console
 $ git checkout master
 ```
 
 Build:
 
-```
+```console
 $ ./configure
 $ make
 ```
 
 To run unit tests:
 
-```
+```console
 $ FLAKY_TESTS=dontcare make test
 ```
 
 To test if Node.js was built correctly with ChakraCore:
 
-```
+```console
 $ node -e "console.log('Hello from Node.js ' + process.jsEngine)"
 Hello from Node.js chakracore
 ```
@@ -143,32 +142,32 @@ Prerequisites:
 
 Install the building tools:
 
-```
-xcode-select --install
-brew install cmake
+```console
+$ xcode-select --install
+$ brew install cmake
 ```
 
 Clone this repo and check out **`master`** branch:
 
-```
-git checkout master
+```console
+$ git checkout master
 ```
 
 Build:
 
-```
-./configure
-make 
+```console
+$ ./configure
+$ make 
 ```
 
 To test if Node.js was built correctly with ChakraCore:
 
-```
+```console
 $ ./node -e "console.log('Hello from Node.js ' + process.jsEngine)"
 Hello from Node.js chakracore
 ```
 
 ### Issues
 
 Please report all issues related to Node-ChakraCore on our
-[issues page](https://github.com/nodejs/node-chakracore/issues).
+[issues page](https://github.com/nodejs/node-chakracore/issues).
diff --git a/TTD-README.md b/TTD-README.md
@@ -58,7 +58,7 @@ TTD functionality is available in Node-ChakraCore and is supported by
 traces even if you don't have the project sources available. This is done by:
 - Creating an empty `dummy.js` file in the trace directory.
 - Adding the following configuration into your `.vscode\launch.json` configuration file.
-```
+```json
 {
     "name": "Trace Debug",
     "type": "node",
@@ -85,10 +85,10 @@ To get started with diagnostic tracing and TTD you will need the following:
 - Install [Node-ChakraCore](https://github.com/nodejs/node-chakracore/releases)
     - (Recommended) install [NVS](https://github.com/jasongin/nvs/blob/master/README.md) which is a cross-platform tool for switching between different versions and forks of Node.js and will allow you to easily switch between Node-ChakraCore and other Node.js versions. Once NVS is installed simply enter the following commands in the console:
 
-        ```
-        nvs remote chakracore-nightly https://nodejs.org/download/chakracore-nightly/
-        nvs add chakracore-nightly/latest
-        nvs use chakracore-nightly
+        ```console
+        $ nvs remote chakracore-nightly https://nodejs.org/download/chakracore-nightly/
+        $ nvs add chakracore-nightly/latest
+        $ nvs use chakracore-nightly
         ```
     - (Manual) Download the build for your platform/architecture and manually add the location of the binaries to your path.
 - Install [VSCode](https://code.visualstudio.com/) using the latest installer.