Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 79 lines (48 sloc) 2.268 kb
492924c @isaacs Move more of the documentation to ronn's domain
isaacs authored
1 # npm
4626dfa Initial drop. Ugly, sketchy, and not even yet quite a "work in progress...
isaacs authored
2
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
3 This is just enough info to get you up and running.
b3f1673 @isaacs another note pointing users to the documentation
isaacs authored
4
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
5 More info available via `man npm`.
841f3b5 @isaacs Move the installing section up to the top
isaacs authored
6
266f1c9 @isaacs Update the README with more helpful info.
isaacs authored
7 ## IMPORTANT
8
9 You need node v0.2.0 or higher to run this program.
10
11 You shouldn't use sudo with it.
12
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
13 ## Simple Install
841f3b5 @isaacs Move the installing section up to the top
isaacs authored
14
5885cbf @isaacs Update readme to reference super duper easy install script.
isaacs authored
15 To install npm, do this:
d49a887 @isaacs add some more installation suggestions/options
isaacs authored
16
5885cbf @isaacs Update readme to reference super duper easy install script.
isaacs authored
17 curl http://npmjs.org/install.sh | sh
d49a887 @isaacs add some more installation suggestions/options
isaacs authored
18
57729b7 @isaacs Documentation updates
isaacs authored
19 If it dies with a "Permission Denied" or EACCESS error, then that probably
266f1c9 @isaacs Update the README with more helpful info.
isaacs authored
20 means that you are running node in a shared root-owned location. You've
21 got options.
57729b7 @isaacs Documentation updates
isaacs authored
22
266f1c9 @isaacs Update the README with more helpful info.
isaacs authored
23 Using sudo with npm is Very Not Recommended. Either chown the folder that
24 is your node install prefix, or set up a `.npmrc` file pointing `root`,
25 `binroot`, and `manroot` to folders that you own. (The .npmrc is just an
26 ini-formatted file, so you can use any editor to do this.)
d49a887 @isaacs add some more installation suggestions/options
isaacs authored
27
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
28 ## More Fancy Installing
29
30 First, get the code. Maybe use git for this. That'd be cool. Very fancy.
31
bf84068 @isaacs update make stuff in the README
isaacs authored
32 The default make target is `install`, which downloads the current stable
895281c @isaacs Update install instructions.
isaacs authored
33 version of npm, and installs that for you.
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
34
895281c @isaacs Update install instructions.
isaacs authored
35 If you want to install the exact code that you're looking at, the bleeding-edge
36 master branch, do this:
37
bf84068 @isaacs update make stuff in the README
isaacs authored
38 make dev
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
39
40 If you'd prefer to just symlink in the current code so you can hack
41 on it, you can do this:
42
895281c @isaacs Update install instructions.
isaacs authored
43 make link
44
45 If you check out the Makefile, you'll see that these are just running npm commands
46 at the cli.js script directly. You can also use npm without ever installing
266f1c9 @isaacs Update the README with more helpful info.
isaacs authored
47 it by using `node cli.js` instead of "npm". Set up an alias if you want, that's
48 fine. (You'll still need read permission to the root/binroot/manroot folders,
49 but at this point, you probably grok all that anyway.)
069a27c @isaacs Add a simpler install process up near the top.
isaacs authored
50
c71ae65 @isaacs version notes for 0.1.11
isaacs authored
51 ## Uninstalling
52
53 So sad to see you go.
54
55 npm uninstall npm
56
57 Or, if that fails,
58
59 make uninstall
d9e9c14 @isaacs Point developers to the docs
isaacs authored
60
266f1c9 @isaacs Update the README with more helpful info.
isaacs authored
61 ## Install Problems
62
63 There's was an issue prior to npm version 0.2.0 where packages whose names contained
64 hyphen characters would be odd.
65
66 If you've installed any packages with `-` in the name prior to 0.2.0, then you ought
67 to remove and reinstall them.
68
d9e9c14 @isaacs Point developers to the docs
isaacs authored
69 ## More Docs
70
71 Check out the [docs](http://github.com/isaacs/npm/blob/master/doc/).
72
5885cbf @isaacs Update readme to reference super duper easy install script.
isaacs authored
73 You can use the [npm help](http://github.com/isaacs/npm/blob/master/doc/help.md#readme)
74 command to read any of them.
75
d9e9c14 @isaacs Point developers to the docs
isaacs authored
76 If you're a developer, and you want to use npm to publish your program,
77 you should
78 [read this](http://github.com/isaacs/npm/blob/master/doc/developers.md#readme)
Something went wrong with that request. Please try again.