In order to build jStat, you need to have GNU make 3.8 or later, Node.js 0.2 or later, and git 1.7 or later. (Earlier versions might work OK, but are not tested.)
Windows users have two options:
- Install msysgit (Full installer for official Git), GNU make for Windows, and a binary version of Node.js. Make sure all three packages are installed to the same location (by default, this is C:\Program Files\Git).
- Install Cygwin (make sure you install the git, make, and which packages), then either follow the Node.js build instructions or install the binary version of Node.js.
Mac OS users should install Xcode (comes on your Mac OS install DVD, or downloadable from
Apple's Xcode site) and
http://mxcl.github.com/homebrew/. Once Homebrew is installed, run
brew install git to install git,
brew install node to install Node.js.
Linux/BSD users should use their appropriate package managers to install make, git, and node, or build from source if you swing that way.
First, clone a copy of the jStat git repo by running
git clone git://github.com/jstat/jstat.git.
To download all necessary libraries run
Then, to get a complete, minified version of jStat and all documentation, simply
cd to the
jstat directory and
make. If you don't have Node installed and/or want to make a basic, uncompressed, unlinted version of jstat,
make jstat instead of
The built version of jStat will be put in the
Generate just the documentation by running
make doc. Documentation will be placed in
dist/docs by default.
To remove all built files, run
Execute all tests by running
Or if you wish to run a specific test,
test/<subdir> and run
We always like discussion of how to improve jStat. Join us at our mailing list and let us know what you'd like to see. Also come ask questions in the #jstat channel on irc.freenode.net.