Skip to content

Commit 9e9a500

Browse files
Brendan GraetzBrendan Graetz
authored andcommitted
=BG= make installation instructions clearer
1 parent 817673d commit 9e9a500

File tree

2 files changed

+49
-27
lines changed

2 files changed

+49
-27
lines changed

getting-started/installation.md

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ to reboot. Once you can see node in the console `echo %PATH%` then you are ready
3030

3131
Unless you just installed `node` you may be running npm older than **npm 2.0.0**. In that case it is worth updating.
3232

33-
`npm install npm -g`.
33+
npm install -g npm
3434

3535
On windows you may have some difficulty and should follow the troubleshooting
3636
[instructions](https://github.com/npm/npm/wiki/Troubleshooting#upgrading-on-windows) from the outset.
@@ -40,13 +40,31 @@ projects.
4040

4141
## Installation
4242

43-
### Default
43+
You will need to install bower, and update npm.
44+
45+
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.
53+
54+
### Stable
4455

4556
The default installation is fairly straightforward.
4657
Installing `npm` simply updates it,
4758
and Angularity expects bower to be available globally.
4859

49-
npm install -g npm bower angularity
60+
npm install -g angularity
61+
62+
If you wish to install a particular release of angularity,
63+
you can install from github instead of the npm registry, like so:
64+
65+
npm install -g angularity/node-angularity#0.0.18
66+
67+
(replace `0.0.18` with the tag you wish to use)
5068

5169
### Latest
5270

@@ -57,33 +75,37 @@ somewhere.
5775
Assuming `CODE` is a folder where you place your code checkouts,
5876
and `NODE` is a folder where NodeJs is installed
5977

60-
npm install -g npm bower angularity
61-
cd ${CODE}
62-
git clone [email protected]:angularity/node-angularity.git
63-
mv node-angularity angularity
64-
cd ${NODE}/lib/node_modules
65-
mv angularity angularity.backup
66-
ln -s ${CODE}/angularity angularity
67-
cd ${CODE}/angularity
68-
npm install
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
6987

7088
### Contributor
7189

7290
If you wish to develop or contribute to the Angularity project,
7391
set up your git checkout to do so.
92+
7493
Firstly, fork the project on github:
7594
[https://github.com/angularity/node-angularity/fork](https://github.com/angularity/node-angularity/fork)
7695

77-
npm install -g npm bower angularity
78-
cd ${CODE}
79-
git clone [email protected]:${GITHUB_USERNAME}/node-angularity.git
80-
mv node-angularity angularity
81-
cd ${NODE}/lib/node_modules
82-
mv angularity angularity.backup
83-
ln -s ${CODE}/angularity angularity
84-
cd ${CODE}/angularity
85-
git remote add upstream [email protected]:angularity/node-angularity.git
86-
npm install
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
87109

88110
Be sure to keep your fork in sync with the main repository
89111
before you start working on any patch.

getting-started/project-setup.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
Ensure that angularity has been installed correctly and is accessible from the command line:
66

7-
which angularity
8-
#should output the path where it is located
7+
which angularity
8+
#should output the path where it is located
99

1010
If you wish to run angularity directly from the project folder,
1111
instead of from the command line after a global `npm` installation,
1212
you can do this instead:
1313

14-
cd angularity # where you have the project checked out
15-
node bin/cli.js
14+
cd angularity # where you have the project checked out
15+
node bin/cli.js
1616

17-
### `.angularity`
17+
### `.angularity` config
1818

1919
Upon your running angularity,
2020
you might encounter a warning that looks like this:

0 commit comments

Comments
 (0)