Update Readme.md

README.md

@@ -1,62 +1,57 @@
-Kute App
-===================
+# What is Kute?
+A Commute App for Sri Lanka
 
+![cover](https://user-images.githubusercontent.com/17242746/34432772-7414905c-eca0-11e7-874e-c38a2c96671f.jpg)
 
-**Kute** is an app that makes navigation and transportation easier and more efficient for people travelling to the same destination.People can easily navigate and identify public transport services around them without having to look through the schedules and timings.Travellers can share their location and tackle the problems of ever-changing schedules together.
+>People travel to the same destination on a regular basis for various reasons using _public and private_ transport. In **Kute**, the users (also known as travellers) themselves are allowed to share their current location, so that the other travellers can see the current location of the vehicle. A common type of vehicle used for public transport in Sri Lanka is the passenger train. Kute is currently implemented for trains. A registered user can update the current location of a train when travelling by sharing the current location. Another user can view location of a selected train and the expected time a particular train arrives at the nearest station using the location data updated by another user.
 
-![enter image description here](http://res.cloudinary.com/raghavp/image/upload/v1513531690/kute1_bhhvhj.png)
+# Features
+- Makes navigation and transportation easier.
+- People can navigate & identify public transport services.
+- Travellers can share their location.
 
-![enter image description here](http://res.cloudinary.com/raghavp/image/upload/v1513531691/kute2_vtvneu.png)
+![ss](https://user-images.githubusercontent.com/17242746/34433097-c0e5f16c-eca2-11e7-922e-086a2a7c0e91.png)
 
-----------
+# Setting up the Project
+- Fork the repository by clicking on the Fork icon at the top right corner of the repository page.
+- Clone the repository on to your local machine by running the following commands on git:
+- git clone git clone `https://github.com/[YOUR-USERNAME]/kute.git` Refer Forking and Cloning in -
+- git if you are stuck somewhere.
+- Download and install Android Studio which is an IDE for android application development.
+- You will also need to download the Android SDK from the IDE itself.
 
+# Development Setup
 
-Installation
--------------
+- Launch android studio (version 1.4 above)
+- you will see a Welcome to Android window. Under Quick Start, select Import Project (Eclipse ADT, Gradle, etc.)
+- Navigate to the directory where you saved the Kute project, select the root folder of the project (the folder named "Kute-master"), and hit OK. 
+- Update `kute-android-app/app/src/main/res/values/strings.xml` with a facebook app id and google maps api key
+```
+<string name="facebook_app_id">YOUR_FB_APP_ID</string>
+<string name="googlemapApi">YOUR_GOOGLE_MAPS_API_KEY</string>
+```
+- Make sure you are connected to internet
+- Run and build the Gradle.
+- Wait for a few seconds and the app should start on your device (android phone or emulator).
 
-You can install and run **Kute App** easily on your android device or emulator using the following instructions
+# Running the Application
 
-1)Download the zip file from the repository at 
-https://github.com/scorelab/kute/tree/c_in_refine or,use the following git command to clone the file 
-> git clone https://github.com/scorelab/kute.git
+- Via your own android smartphone
+Enable USB Debugging in your phone. Click Run on the Android Studio tool bar, or `Shift + F10` to run the app. By running a virtual device.
 
-2)Next set up Android Studio on your device,using the following link 
-https://developer.android.com/studio/install.html
-
-3)Start Android studio and download the SDK's
-
-4)Set Up your emulator in Android Studio,you can do so by going to Tools>Android>AVD Manager,next you will be prompted with instructions to set up your emulator.
-
-5)Go to the zip file or navigate to the directory using the "Cd" command and launch the project
-
-6)The project will build automatically,there might be some errors but android studio will provide you with the problem and even give you an option to install the required components causing the error.
-
-7)After this Run the app and select the emulator or your android device.
-
-8)Wait for the emulator to start up and turn on,later the APK file will install automatically 
-
-9)Kute App will start up once you open the APK file you can use the following facebook credentials to log in 
+- Setup a Android Virtual Device in the IDE.
+Then running the application by clicking on Run on the Android Studio tool bar, or `Shift + F10` and then choose the newly created virtual device to run the app.
 
 **Login 1**
-
-Email: [email protected]
-Password: kute123
-
+Email: [email protected] Password: kute123
 **Login 2**
+Email: [email protected] Password: kute123
 
-Email: [email protected]
-Password: kute123
-
-**That's It :)**
-
-Troubleshooting
--------------
-1)Android Manifest incorrect root - In this case restart the project and on the bottom left you will see an option to configure android framework ,do so.
-
-2)Google Maven files not installed - in this case just follow the prompt provided by android studio.
-
-3)SDK Files for emulator not installed - in this case you can try restarting the project and set up the emulator.
-
-
+# Google Code-in 2017
 
+Google Code-in users should checkout the c_in_refine branch for all tasks.
+`git checkout c_in_refine`
+You'll have all the necessary information to proceed in there.
 
+# License
+This project is licensed under the terms of the Apache License 2.0.