Skip to content

Commit c14f5be

Browse files
docs(README,LICENSE): add main doc
1 parent 45e18bf commit c14f5be

File tree

2 files changed

+18
-23
lines changed

2 files changed

+18
-23
lines changed

LICENSE.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
"THE BEER-WARE LICENSE" (Revision 42):
2+
<[email protected]> wrote this file. As long as you retain this notice you
3+
can do whatever you want with this stuff. If we meet some day, and you think
4+
this stuff is worth it, you can buy us a beer in return. M2GIL 2017

README.md

+14-23
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
11
# IAtaaaClient
22

3-
This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.17.
3+
IAtaaaClient is a software build by some students from the University of Rouen.
4+
This is a FOSS so you can do what you want with it. Just check the
5+
[license](LICENSE.md) for more informations about how to thank us for this work.
46

5-
## Development server
6-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
7+
## Requirements
78

8-
## Code scaffolding
9+
* npm
10+
* angular-cli `npm i -g angular-cli`
911

10-
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/class`.
12+
## Installation
1113

12-
## Build
14+
Clone this repository, then run `npm install`. Then, when
15+
everything is installed, you just need to run `ng serve` to
16+
run the app in debug mode.
1317

14-
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build.
18+
## Contributors
1519

16-
## Running unit tests
17-
18-
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
19-
20-
## Running end-to-end tests
21-
22-
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
23-
Before running the tests make sure you are serving the app via `ng serve`.
24-
25-
## Deploying to Github Pages
26-
27-
Run `ng github-pages:deploy` to deploy to Github Pages.
28-
29-
## Further help
30-
31-
To get more help on the `angular-cli` use `ng --help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
20+
* Yoann FLEURY <[email protected]>
21+
* Pierre-Luc BLOT
22+
* Axelle BOUCHER

0 commit comments

Comments
 (0)