Skip to content

Commit

Permalink
docs(README,LICENSE): add main doc
Browse files Browse the repository at this point in the history
  • Loading branch information
yoannfleurydev committed Feb 8, 2017
1 parent 45e18bf commit c14f5be
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 23 deletions.
4 changes: 4 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
"THE BEER-WARE LICENSE" (Revision 42):
<[email protected]> wrote this file. As long as you retain this notice you
can do whatever you want with this stuff. If we meet some day, and you think
this stuff is worth it, you can buy us a beer in return. M2GIL 2017
37 changes: 14 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,22 @@
# IAtaaaClient

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

## Development server
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.
## Requirements

## Code scaffolding
* npm
* angular-cli `npm i -g angular-cli`

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

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

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.
## Contributors

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
Before running the tests make sure you are serving the app via `ng serve`.

## Deploying to Github Pages

Run `ng github-pages:deploy` to deploy to Github Pages.

## Further help

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).
* Yoann FLEURY <[email protected]>
* Pierre-Luc BLOT
* Axelle BOUCHER

0 comments on commit c14f5be

Please sign in to comment.