Skip to content
This repository was archived by the owner on May 25, 2019. It is now read-only.

Commit 3d2da2b

Browse files
committedJul 29, 2013
[M] Update README
1 parent ec25681 commit 3d2da2b

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed
 

‎README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ This generator use Grunt, AngularJS, RequireJS and jQuery.
55

66
## How to add it !
77

8-
Add it as a submodule of your module.
8+
Add it as a bower component.
99

1010
```sh
11-
git submodule add git://github.com/angular-ui/angular-ui-docs.git out
11+
bower install git://github.com/angular-ui/angular-ui-docs.git
12+
```
13+
or add to your `bower.json`
14+
```Javascript
15+
"devDependencies": {
16+
"angular-ui-docs": "angular-ui/angular-ui-docs"
17+
}
1218
```
1319

1420
**It's working with ssh deploy key !**
@@ -25,7 +31,7 @@ env:
2531

2632
Then add the scripts and limit the build-able branches.
2733

28-
```
34+
```yaml
2935
before_script: out/.travis/before_script.sh
3036
after_success: out/.travis/after_success.sh
3137
branches:
@@ -75,3 +81,23 @@ This will generate `index.html` using :
7581
- the `meta.view.humaName` as title of the demo site,
7682
- the `meta.view.repoName` in the github links,
7783

84+
85+
## See it working locally !
86+
Actually the demo must be built !
87+
We are using _bower_ and _grunt_ for this.
88+
89+
First in you UI project run
90+
```sh
91+
npm install && bower install
92+
grunt build-doc
93+
```
94+
95+
Then run a localhost on `bower_components/angular-ui-docs`
96+
```sh
97+
cd bower_components/angular-ui-docs
98+
python -m SimpleHTTPServer
99+
or
100+
php -S localhost:8000
101+
```
102+
103+
and you'll have the generated website on http://localhost:8000/

0 commit comments

Comments
 (0)
This repository has been archived.