Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update README.md to improve the getting started/installation documentation of my experience
  • Loading branch information
rizkyarifin authored Dec 11, 2017
1 parent 6484ef5 commit 075181d
Showing 1 changed file with 9 additions and 19 deletions.
28 changes: 9 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,39 +11,29 @@ People travel to the same destination on a regular basis for various reasons usi

## Installation

1. Go to your terminal and execute this command
1. Download the zip file and then unzip the contents.

`git clone https://github.com/scorelab/kute.git`

or download the zip file and then unzip the contents.
2. Launch android studio(version 1.4 above).

2. Checkout the branch 'c_in_refine' (Only for Google Code In participants).
3. To import the project: Click on file, then click Open or from the welcome screen of android studio click Open an existing Android Studio Project. (If you wish to contribute, you can directly link to GitHub)

`cd kute`

`git checkout c_in_refine`
4. Browse to the location where you had extracted the zip and then select the folder kute-android-app in it.

3. Launch android studio(version 1.4 above).
5. Android studio will automatically run and build the Gradle for you. In case of anything missing, studio will prompt you on the messages tab to download the needed file and sync project, click on it.

4. To import the project: Click on File, then New and then Import Project or from the welcome screen of android studio click on Import project. (If you wish to contribute, you can directly link to GitHub).
6. If Gradle finishes to build without error, connect your phone or emulator and run the project by clicking on the play button on the tool bar.

5. Browse to the location where you had extracted the zip and then select the folder kute-android-app in it.
7. Wait for a few seconds and the app should start on your device(android phone or emulator), make sure you are connected to Internet.

6. Android studio will automatically run and build the Gradle for you. In case of anything missing, studio will prompt you to download the needed file and sync project, click on it.

7. If Gradle finishes to build without error, connect your phone or emulator and run the project by clicking on the play button on the tool bar.

8. Wait for a few seconds and the app should start on your device(android phone or emulator), make sure you are connected to Internet.

9. Possible errors while building the app:
8. Possible errors while building the app:
a) Colors not found
Solution- Within studio, navigate to res-> values -> colors.xml and add the missing colors here.
b) String not found
Solution- Within studio, navigate to res-> values -> strings.xml and add the missing strings here.
c) Dusplicate strings found
Solution- Within studio, navigate to res-> values -> strings.xml and remove the strings that are mentioned more than once.

10. The app should now build successfully and run without any errors
9. The app should now build successfully and run without any errors

Note: Please use the Facebook credentails given below to access the application.

Expand Down

0 comments on commit 075181d

Please sign in to comment.