archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

update installation instructions (#282)

Browse Source
This commit is contained in:
Jeff Williams 2012-12-21 12:02:32 -08:00
parent b07d19f43a
commit f49d69e05d
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -11,21 +11,27 @@ Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.
Installation
------------
Download a copy of JSDoc 3 from the official GitHub repository:
https://github.com/jsdoc3/jsdoc
Use git to clone the [official JSDoc repository](https://github.com/jsdoc3/jsdoc):
Or if you have Node.js installed, use npm:
git clone git@github.com:jsdoc3/jsdoc.git
npm install -g git://github.com/jsdoc3/jsdoc.git
Alternatively, you can download a .zip file for the
[latest development version](https://github.com/jsdoc3/jsdoc/archive/master.zip)
or a [previous release](https://github.com/jsdoc3/jsdoc/tags).
You can also install JSDoc within a Node.js project using npm:
npm install git://github.com/jsdoc3/jsdoc.git
**Note**: Although you can install JSDoc with npm, JSDoc does not currently run
on Node.js.
on Node.js. In addition, installing JSDoc globally with `npm install -g` is not
currently supported.
Usage
-----
This example assumes that your working directory is the jsdoc application base
This example assumes that your working directory is the JSDoc application base
directory:
./jsdoc yourSourceCodeFile.js