Skip to content

Commit 0b3f55b

Browse files
cleaning up tdd
1 parent 99dc9e5 commit 0b3f55b

File tree

1 file changed

+108
-58
lines changed

1 file changed

+108
-58
lines changed

README.md

Lines changed: 108 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -4,103 +4,153 @@ This is the toy app for lesson 3 of the [Android App Development in Kotlin cours
44

55
## Android Trivia
66

7+
8+
Since students haven't yet learned about saving data or the Android lifecycle, it tries to eliminate bugs caused by configuration changes.
9+
10+
<p align="center">
11+
<a href="https://github.com/kevinmainairungu/AboutMe">
12+
<img src="screenshots/screenshoutabout.png" alt="Project Name" width=250 height=160>
13+
</a>
14+
<h3 align="center">About Me</h3>
15+
16+
<p align="center">
17+
A trivia game<br>
18+
on Android.
19+
<br>
20+
<img src="https://forthebadge.com/images/badges/built-for-android.svg" alt="droidconKE2020 built for Android">
21+
<br>
22+
</p>
23+
</p>
24+
25+
<br>
26+
27+
### Table of contents
28+
29+
**1 [About the App](#about-the-app)**<br>
30+
**2 [General Preview](#general-preview)**<br>
31+
**3 [Technical](#technical)**<br>
32+
**4 [Work in Progress](#work-in-progress)**<br>
33+
**5 [Contributing](#contributing)**<br>
34+
**6 [License](#license)**<br>
35+
**7 [Versions](#versions)**<br>
36+
**8 [Contributers](#contributers)**<br>
37+
38+
:point_down: :point_down: :point_down: :point_down: :point_down:
39+
40+
41+
<hr>
42+
## About the app
743
The Android Trivia application is an application that asks the user trivia questions about Android development. It makes use of the Navigation component within Jetpack to move the user between different screens. Each screen is implemented as a Fragment.
844
The app navigates using buttons, the Action Bar, and the Navigation Drawer.
9-
Since students haven't yet learned about saving data or the Android lifecycle, it tries to eliminate bugs caused by configuration changes.
45+
<hr>
46+
## General Preview
47+
#### Screenshots of the app
48+
49+
<img src="screenshots/Screenshot_1587483765.png" width="200">
50+
<img src="screenshots/Screenshot_1587490002.png" width="200">
51+
52+
##### Or combine 2 of them as:
53+
![2images](screenshots/two.jpg) width ="300""
54+
1055

11-
## Screenshots
56+
<hr>
57+
## Technical
58+
## Permissions
59+
* Any permissions needed by the app i.e:
1260

13-
![Screenshot1](screenshots/screen_1.png) ![Screenshot2](screenshots/screen_2.png)
61+
1. Internet
62+
2. Browse phone
1463

15-
## How to use this repo while taking the course
64+
<hr>
1665

66+
#### Running the project
67+
You can:
1768

18-
Each code repository in this class has a chain of commits that looks like this:
69+
a. clone the project and compile it yourself in android studio(Most up to date)
70+
b. Run the already compiled version on the(the proect comes with an apk folderwith various apk versions).
1971

20-
![listofcommits](https://d17h27t6h515a5.cloudfront.net/topher/2017/March/58befe2e_listofcommits/listofcommits.png)
72+
<hr>
2173

22-
These commits show every step you'll take to create the app. Each commit contains instructions for completing the that step.
74+
### TECHNICAL
2375

24-
Each commit also has a **branch** associated with it of the same name as the commit message, seen below:
76+
#### How to use
2577

26-
![branches](https://d17h27t6h515a5.cloudfront.net/topher/2017/April/590390fe_branches-ud855/branches-ud855.png
27-
)
28-
Access all branches from this tab
78+
**1. Required to run project:**
79+
` - To run this project use Android studio 3.* and later. It will be less messy.
80+
- Gradle version used: gradle 4.0. You can use multiple gradle versions vby having them stored offline. [You can read this to set it up.](www.sth)
81+
`
2982

30-
![listofbranches](https://d17h27t6h515a5.cloudfront.net/topher/2017/March/58befe76_listofbranches/listofbranches.png
31-
)
83+
**2. Clone this repository :**
84+
85+
`https://github.com/kevinmainairungu/AboutMe.git`
86+
87+
**3. open Project in Android Studio
3288

89+
**4. Build Project**
3390

34-
![branchesdropdown](https://d17h27t6h515a5.cloudfront.net/topher/2017/April/590391a3_branches-dropdown-ud855/branches-dropdown-ud855.png
35-
)
91+
**5. Incase of an eror when building project, update your gradle version, Build Tools download**
3692

37-
The branches are also accessible from the drop-down in the "Code" tab
3893

94+
#### Dependencies
3995

40-
## Working with the Course Code
96+
## To Do List
4197

42-
Here are the basic steps for working with and completing exercises in the repo.
4398

44-
The basic steps are:
99+
- [x] Adding a findViewById resource instance for the images
100+
- [ ] SplashScreen
101+
- [x] Binding data
102+
- [x] Updating the App to gradle 5.x
103+
- [X] Button for the 'done' functionality
104+
- [ ] Creating additional activities for more details
105+
- [ ] Add recycler view
106+
- [ ] Link to projects
45107

46-
1. Clone the repo
47-
2. Checkout the branch corresponding to the step you want to attempt
48-
3. Find and complete the TODOs
49-
4. Optionally commit your code changes
50-
5. Compare your code with the solution
51-
6. Repeat steps 2-5 until you've gone trough all the steps to complete the toy app
52108

53109

54-
**Step 1: Clone the repo**
110+
#### CONTRIBUTING
111+
### Assets
112+
* Credit to artists(music,images,gifs...)
55113

56-
As you go through the course, you'll be instructed to clone the different exercise repositories, so you don't need to set these up now. You can clone a repository from github in a folder of your choice with the command:
114+
### List of the Contributors on GitHub
115+
* [Contributors](https://github.com/kevinmainairungu/AboutMe/graphs/contributors)
57116

58-
```bash
59-
git clone https://github.com/udacity/REPOSITORY_NAME.git
60-
```
117+
### Want to contribute?
118+
I would/ We'd love to have your help in making **{this app (About me)}** better. The project is still very incomplete, but if there's an issue you'd like to see addressed sooner rather than later, let me(/us) know.
61119

62-
**Step 2: Checkout the step branch**
120+
Before you contribute though read the contributing guide here: [COntributing.md](https://github.com/YourUserNameHere/ProjectName/contributing.md)
63121

64-
As you go through different steps in the code, you'll be told which step you're on, as well as a link to the corresponding branch.
122+
For any concerns, please open an [issue](https://github.com/kevinmainairungu/AboutMe/issues), or JUST, [fork the project and send a pull request{edit this}](https://github.com/kevinmainairungu/AboutMe/pulls).
65123

66-
You'll want to check out the branch associated with that step. The command to check out a branch would be:
124+
<hr>
67125

68-
```bash
69-
git checkout BRANCH_NAME
70-
```
126+
## License
127+
* see [LICENSE](https://github.com/kevinmainairungu/AboutMe/blob/master/LICENSE) file
71128

72-
**Step 3: Find and complete the TODOs**
73129

74-
Once you've checked out the branch, you'll have the code in the exact state you need. You'll even have TODOs, which are special comments that tell you all the steps you need to complete the exercise. You can easily navigate to all the TODOs using Android Studio's TODO tool. To open the TODO tool, click the button at the bottom of the screen that says TODO. This will display a list of all comments with TODO in the project.
130+
## Versions
131+
* Version X.Y DATE 12/2/2019
75132

76-
We've numbered the TODO steps so you can do them in order:
77-
![todos](https://d17h27t6h515a5.cloudfront.net/topher/2017/March/58bf00e7_todos/todos.png
78-
)
79133

80-
**Step 4: Commit your code changes**
81134

82-
After You've completed the TODOs, you can optionally commit your changes. This will allow you to see the code you wrote whenever you return to the branch. The following git code will add and save **all** your changes.
135+
## Contributers
136+
For personal feedback or questions feel free to contact me via the mail address, which is mentioned on my [Github profile](link (https://github.com/kevinmainairungu). If you have found any bugs or want to post a feature request please use the [bugtracker](https://github.com/kevinmainairungu/AboutMe/issues) to report them.
83137

84-
```bash
85-
git add .
86-
git commit -m "Your commit message"
87-
```
88138

89-
**Step 5: Compare with the solution**
139+
#### Developer/Company
140+
* Homepage:
141+
* e-mail:
142+
* Twitter: [@maina_irungu_](https://twitter.com/maina_irungu_ "maina_irungu_")
143+
* other communication channels i.e Social Media, Forum etc
90144

91-
Most exercises will have a list of steps for you to check off in the classroom. Once you've checked these off, you'll see a pop up window with a link to the solution code. Note the **Diff** link:
92145

93-
![solutionwindow](https://d17h27t6h515a5.cloudfront.net/topher/2017/March/58bf00f9_solutionwindow/solutionwindow.png
94-
)
146+
https://contributors-img.firebaseapp.com/
95147

96-
The **Diff** link will take you to a Github diff as seen below:
97-
![diff](https://d17h27t6h515a5.cloudfront.net/topher/2017/March/58bf0108_diffsceenshot/diffsceenshot.png
98-
)
148+
<hr>
99149

100-
All of the code that was added in the solution is in green, and the removed code (which will usually be the TODO comments) is in red.
150+
If its open source:
101151

102-
You can also compare your code locally with the branch of the following step.
152+
[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source-200x33.png?v=103)](https://github.com/ellerbrock/open-source-badge/)
103153

104-
## Report Issues
105-
Notice any issues with a repository? Please file a github issue in the repository.
154+
Licence is MIT:
106155

156+
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=for-the-badge)]()

0 commit comments

Comments
 (0)