Skip to content

Commit 6334553

Browse files
committed
docs(README): add initial draft of README
1 parent e680cb6 commit 6334553

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Angular-CLI
2+
3+
## Note
4+
5+
This projects is very much still a work in progress.
6+
7+
We still have a long way before getting out of our alpha stage.
8+
If you wish to collaborate while the project is still young, checkout [our list issues](https://github.com/angular/angular-cli/issues).
9+
10+
## Installation
11+
12+
```bash
13+
npm install -g angular-cli
14+
```
15+
16+
## Usage
17+
18+
```bash
19+
ng --help
20+
```
21+
22+
### Generating and serving an Angular2 project
23+
24+
```bash
25+
ng new PROJECT_NAME
26+
cd PROJECT_NAME
27+
ng serve
28+
```
29+
30+
## Development Hints
31+
32+
### Working with master
33+
34+
```bash
35+
git clone https://github.com/angular/angular-cli.git
36+
cd angular-cli
37+
npm link
38+
```
39+
40+
`npm link` is very similar to `npm install -g` except that instead of downloading the package
41+
from the repo, the just cloned `angular-cli/` folder becomes the global package.
42+
Any changes to the files in the `angular-cli/` folder will immediately affect the global `angular-cli` package,
43+
allowing you to quickly test any changes you make to the cli project.
44+
45+
Now you can use `angular-cli` via the command line:
46+
47+
```bash
48+
ng new foo
49+
cd foo
50+
npm link angular-cli
51+
ng server
52+
```
53+
54+
`npm link angular-cli` is needed because by default the globally installed `angular-cli` just loads
55+
the local `angular-cli` from the project which was fetched remotely from npm.
56+
`npm link angular-cli` symlinks the global `angular-cli` package to the local `angular-cli` package.
57+
Now the `angular-cli` you cloned before is in three places:
58+
The folder you cloned it into, npm's folder where it stores global packages and the `angular-cli` project you just created.
59+
60+
Please read the official [npm-link documentation](https://www.npmjs.org/doc/cli/npm-link.html)
61+
and the [npm-link cheatsheet](http://browsenpm.org/help#linkinganynpmpackagelocally) for more information.

0 commit comments

Comments
 (0)