From 09d5ad02ac1d8652876cad05b7e3f427ca3690f1 Mon Sep 17 00:00:00 2001 From: Ismo Vuorinen Date: Tue, 25 Jun 2013 12:08:47 +0300 Subject: [PATCH] README: Prerequisites, building and credits --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d4b6479..df5bd25 100644 --- a/README.md +++ b/README.md @@ -5,13 +5,30 @@ Flight CO2 emission calculator. Uses [Grunt: The JavaScript Task Runner](http://gruntjs.com/getting-started). -Dependencies +## Installation ## + +### Prerequisites ### +- Webserver that runs PHP to poll the airport data +- MySQL server to hold the data +- [npm](https://npmjs.org), [bower](http://bower.io) and [grunt](http://gruntjs.com) to fetch dependencies and to build the project + +Lentolaskuri has been tested and build using tested on [MAMP](http://www.mamp.info) and [LAMP](http://en.wikipedia.org/wiki/LAMP_\(software_bundle\)) stack. + + +### Dependencies ### ``` npm install && bower install ``` -Building the project +### Building the project ### ``` grunt server # Start development server grunt # Build minified and optimized version for release ``` + +## Credits ## + +- Build by [Juho Teperi](https://github.com/Deraen) in 2013 while working for [Ekokumppanit Oy](http://www.ekokumppanit.fi) +- Currently maintained by [Ismo Vuorinen](https://github.com/ivuorinen) + +Airport data comes from [OpenFlights.org](http://openflights.org) ([airports.dat](http://sourceforge.net/p/openflights/code/HEAD/tree/openflights/data/airports.dat), [AGPL](http://www.gnu.org/licenses/agpl.html)) \ No newline at end of file