Skip to content

Commit a4829c3

Browse files
committed
fixed misleading installation doc
1 parent a163f44 commit a4829c3

File tree

1 file changed

+13
-57
lines changed

1 file changed

+13
-57
lines changed

getting-started/installation.md

Lines changed: 13 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -38,76 +38,32 @@ On windows you may have some difficulty and should follow the troubleshooting
3838
Be aware however that npm 2 has [**breaking changes**](http://blog.npmjs.org/post/98131109725/npm-2-0-0) for existing
3939
projects.
4040

41-
## Installation
41+
## Install Bower
4242

43-
You will need to install bower, and update npm.
43+
Most angularity projects want to utilise [bower](http://bower.io/). Perform a global installation using npm.
4444

4545
npm install -g bower
46-
npm install -g npm
47-
48-
Next, we will install angularity.
49-
Decide whether you wish to use the last stable release,
50-
the latest commit,
51-
and if you wish to contribute to the project,
52-
and follow the appropriate set of instructions below.
5346

54-
### Stable
47+
## Install Angularity
5548

56-
The default installation is fairly straightforward.
57-
Installing `npm` simply updates it,
58-
and Angularity expects bower to be available globally.
49+
Perform a global installation using npm.
5950

6051
npm install -g angularity
6152

62-
If you wish to install a particular release of angularity,
63-
you can install from github instead of the npm registry, like so:
53+
If you wish to install a particular release of angularity, you can install from github instead of the npm registry.
6454

65-
npm install -g angularity/node-angularity#0.0.18
55+
npm install -g angularity/node-angularity#<TAG>
6656

67-
(replace `0.0.18` with the tag you wish to use)
57+
## [optional] Angularity Source Code
6858

69-
### Latest
59+
If you wish to develop or contribute to the Angularity project you will need to [fork the project]([https://github.com/angularity/node-angularity/fork](https://github.com/angularity/node-angularity/fork) on github.
7060

71-
For those who wish to live on the bleeding edge,
72-
you will need to symlink the global npm package to
73-
somewhere.
61+
Get local a working copy of your fork.
7462

75-
Assuming `CODE` is a folder where you place your code checkouts,
76-
and `NODE` is a folder where NodeJs is installed
77-
78-
npm install -g angularity
79-
cd ${CODE}
80-
git clone [email protected]:angularity/node-angularity.git
81-
mv node-angularity angularity
82-
cd ${NODE}/lib/node_modules
83-
mv angularity angularity.backup
84-
ln -s ${CODE}/angularity angularity
85-
cd ${CODE}/angularity
86-
npm install
63+
git clone [email protected]:<YOUR_GITHUB_USERNAME>/node-angularity.git
8764

88-
### Contributor
65+
Force the global install to defer to this working copy.
8966

90-
If you wish to develop or contribute to the Angularity project,
91-
set up your git checkout to do so.
67+
npm link
9268

93-
Firstly, fork the project on github:
94-
[https://github.com/angularity/node-angularity/fork](https://github.com/angularity/node-angularity/fork)
95-
96-
Then run these commands to clone your forked repository,
97-
and then link it from NodeJs' global folder.
98-
99-
npm install -g angularity
100-
cd ${CODE}
101-
git clone [email protected]:${GITHUB_USERNAME}/node-angularity.git
102-
mv node-angularity angularity
103-
cd ${NODE}/lib/node_modules
104-
mv angularity angularity.backup
105-
ln -s ${CODE}/angularity angularity
106-
cd ${CODE}/angularity
107-
git remote add upstream [email protected]:angularity/node-angularity.git
108-
npm install
109-
110-
Be sure to keep your fork in sync with the main repository
111-
before you start working on any patch.
112-
This [how to on Github](https://help.github.com/articles/syncing-a-fork/)
113-
is most helpful.
69+
Be sure to keep your fork in sync with the main repository before you start working on any patch. This [how to on Github](https://help.github.com/articles/syncing-a-fork/) is most helpful.

0 commit comments

Comments
 (0)