Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
45 lines (28 sloc) 1.69 KB

INSTALL

copyright (c) 2010, R. S. Doiel, all rights reserved

Licensed under "The BSD License" described at http://opensource.org/licenses/bsd-license.php

OVERVIEW

nshtools is a NodeJS module and example program called syncme.js.

REQUIREMENTS

  • node >= 1.30 [1]

  • git [2]

INSTALLING

nshtools comes with a simple installer. This is a simple installer written using nshtools.js to install nshtools.js module and syncme.js. It has one option.

--Prefix

The prefix of where you want things installed.

nshtools needs to have node already installed. See http://nodejs.org for details.

simple install
node install-nshtools.js
install in /usr/local
node install-nshtools.js --prefix=/usr/local

GORY DETAILS

Typically node modules live in two place /usr/local/lib/node/libraries or $HOME/.node_libraries. If you write your own module or download someone elses and don’t want to play with process.paths you wind up coping that module to where the rest of the modules live. Likewise if you’ve written an application you wind up copying it to a "bin" folder on many Unix systems. install-nshtools.js does this for you based on the prefix path.

The default prefix path is your local home directory. The installer will fail if the directories don’t exists. That is one of the ways it is simple.

Note
$HOME/bin for syncme.js and $HOME/.node_libraries for nshtools.js, otherwise nshtools is put in $PREFIX/lib/node/libraries.

1 see nodejs.org for details.
2 see git-scm.com for details
Jump to Line
Something went wrong with that request. Please try again.