From c14f5bef68ce8949fc3ae9d432e01627c3917f70 Mon Sep 17 00:00:00 2001 From: Yoann Fleury Date: Wed, 8 Feb 2017 21:41:12 +0100 Subject: [PATCH] docs(README,LICENSE): add main doc --- LICENSE.md | 4 ++++ README.md | 37 ++++++++++++++----------------------- 2 files changed, 18 insertions(+), 23 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..17bf117 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,4 @@ +"THE BEER-WARE LICENSE" (Revision 42): + 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 diff --git a/README.md b/README.md index 4c605c7..caba25e 100644 --- a/README.md +++ b/README.md @@ -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 +* Pierre-Luc BLOT +* Axelle BOUCHER