Skip to content
This repository has been archived by the owner on Oct 15, 2020. It is now read-only.

Commit

Permalink
Update README.md (#149)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.md

* Updated with feedback

* Update README.md
  • Loading branch information
aruneshchandra authored Nov 26, 2016
1 parent 3d3d6e1 commit e11f649
Showing 1 changed file with 36 additions and 13 deletions.
49 changes: 36 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Node.js on ChakraCore

This project enables Node.js to optionally use the ChakraCore JavaScript
engine. This project is still **work in progress** and not an officially
supported Node.js branch. Please refer to the original
[PR] (https://github.com/nodejs/node/pull/4765).
supported Node.js branch. For more context into this project, please refer to the
[original PR] (https://github.com/nodejs/node/pull/4765).

### How it works

Expand All @@ -18,19 +18,36 @@ modules written for V8.
A rebuild of node and native addon modules with ChakraCore is required for this
to work.

### Issues
### Time Travel Debugging
Time-Travel debugging is an exciting new addition to Node.js debugging, first introduced in Node-ChakraCore, and now supported by [VSCode](https://github.com/microsoft/vscode/). We are developing in the open and want to share our progress to get feedback, bug reports, functionality requests, and pull-requests from the community.

Check out this [Time-Travel Debugging](https://github.com/nodejs/node-chakracore/blob/xplat/TTD-README.md) page to learn how to get started with TTD on Node-ChakraCore with VSCode.

### Node.js API (NAPI)
Node-ChakraCore is an active participant in the [ABI-Stable-Node](https://github.com/nodejs/abi-stable-node) project also called NAPI. The goal of this project is to ease the lives of native add-ons developers, by providing a stable Node API which also guarantees stable ABI across disparate Node versions. This allows native modules to just work across different versions and flavors of Node.js without recompilations, reducing the maintenance cost for module developers and thus improving compatibility.

Head over to the [NAPI Project repo](https://github.com/nodejs/abi-stable-node) to learn more about it and ways to get involved.

Please report all issues related to Node-ChakraCore on this separate
[issue page] (https://github.com/nodejs/node-chakracore/issues).
### Installing prebuilt Node-ChakraCore binaries

### Prebuilt Node-ChakraCore binaries
You can download and install stable prebuilt Node-ChakraCore from the [releases page](https://github.com/nodejs/node-chakracore/releases).

You can download and install prebuilt Node-ChakraCore from the releases page.
Currently available for:
_For installing Node-ChakraCore side-by-side your existing Node installation, we recommend [Node Version Switcher (NVS)](https://github.com/jasongin/nvs)._

* Windows 7+: [here] (https://aka.ms/node-chakracore-release-windows)
* Ubuntu 16.04 LTS x64:
[preview here] (https://aka.ms/node-chakracore-release-linux)
```
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
```

### Building Node-ChakraCore

Expand Down Expand Up @@ -62,7 +79,7 @@ C:\>node -e "console.log('Hello from Node.js ' + process.jsEngine)"
Hello from Node.js chakracore
```

#### Linux
#### Linux / macOS

Prerequisites:
* Ubuntu 16.04 LTS x64
Expand All @@ -84,7 +101,6 @@ Build:
```
./configure --engine=chakracore
make
[sudo] make install
```

To run unit tests:
Expand All @@ -99,3 +115,10 @@ To test if Node.js was built correctly with ChakraCore:
$ 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).


0 comments on commit e11f649

Please sign in to comment.