Permalink
Browse files

First contents

  • Loading branch information...
1 parent bc5b446 commit 3368c3d8474b067c63880cc1db3d9d6f4cd1aeac @baudehlo committed May 3, 2011
Showing with 29 additions and 1 deletion.
  1. +28 −0 README.md
  2. +1 −1 nodedoc
View
@@ -0,0 +1,28 @@
+Nodedoc
+=======
+
+This quick hack module gives you access to node documentation on the
+command line.
+
+Installation
+------------
+
+First edit the file `nodedoc` and change the value of `NODE_DOC_DIR` in that
+file. This is the directory to the `node/doc/api` directory. You can make
+a global installation by creating the directory `/usr/local/share/node/doc`
+and copying the files there.
+
+Then copy the `nodedoc*` files to somewhere in your path:
+
+ $ sudo cp nodedoc* /usr/local/bin/
+
+Finally, to find documentation for the 'fs' module, type:
+
+ $ nodedoc fs
+
+It's all a bit rough and ready. Patches welcome. It requires a perl and
+an nroff installation to work.
+
+Contains code from the [markdown-js][1] project.
+
+[1]: https://github.com/evilstreak/markdown-js
View
@@ -1,6 +1,6 @@
#!/bin/sh
-export NODE_DOC_DIR=/Users/matt/Perl/node/doc/api
+export NODE_DOC_DIR=/usr/local/share/node/doc
export NODEDOC_JS="$0/../nodedoc.js"
export LESSCHARSET=iso8859

0 comments on commit 3368c3d

Please sign in to comment.