osrm/node_modules/node-cmake/example/README.md

The Open Source Routing Machine is a high performance routing engine written in C++14 designed to run on OpenStreetMap data.

Native Addon
============

An example native addon, adjusted to use Nan for cross-variant compatibility, 
from the Node.js documentation site for [Addons](https://nodejs.org/api/addons.html).

## Development Setup

This module requires node-cmake and is a part of node-cmake's distribution. A normal
project should copy NodeJS.cmake to their own project; this just refers to its
location in this project, one directory above.

## Building

Once setup is complete, just run `npm install`. The module will build a
version appropriate to the system and architecture for your node executable.

## Running

This just exposes a module that directly exposes the native addon, dealing
with finding the correct module for the platform across different output
directories and build configurations.

A good way to validate that it is working is to run from this folder:

    node -p "require('./index').hello()"

If everything worked correctly, you should see it print "world".