From 32f2673e00ddf0714c4a43a4a31d9d8cab981ab8 Mon Sep 17 00:00:00 2001 From: isaacs Date: Sun, 4 Sep 2011 11:21:30 -0700 Subject: Add README as proper html/manpage doc --- Makefile | 2 +- README.md | 8 ++ html/doc/README.html | 8 +- man1/README.1 | 313 +++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 329 insertions(+), 2 deletions(-) create mode 100644 man1/README.1 diff --git a/Makefile b/Makefile index 937c889f4..2c2ad4be7 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ SHELL = bash docs = $(shell find doc -name '*.md' \ |sed 's|.md|.1|g' \ - |sed 's|doc/|man1/|g' ) + |sed 's|doc/|man1/|g' ) man1/README.1 htmldocs = $(shell find doc -name '*.md' \ |sed 's|.md|.html|g' \ diff --git a/README.md b/README.md index 547654335..9ebb2e397 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ npm(1) -- node package manager ============================== +## SYNOPSIS + This is just enough info to get you up and running. Much more info available via `npm help` once it's installed. @@ -187,3 +189,9 @@ reported, and we'll lose respect for you. But there is no vetting process for published modules. If this concerns you, inspect the source before using packages. + +## SEE ALSO + +* npm(1) +* npm-faq(1) +* npm-help(1) diff --git a/html/doc/README.html b/html/doc/README.html index d3b9c1580..66244f86f 100644 --- a/html/doc/README.html +++ b/html/doc/README.html @@ -1,6 +1,6 @@ - + <a href="README.html">README</a>