Skip to content

Commit 02f30c2

Browse files
authored
Update README.md
1 parent 1df26c5 commit 02f30c2

1 file changed

Lines changed: 56 additions & 1 deletion

File tree

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,57 @@
11
# Android-Development
2-
This repository walks a programmer through android application development. Prerequisites : Java, Fundamental Knowledge of Version Control and JSON
2+
This repository walks a programmer through android application development. Prerequisites : Java, Fundamental Knowledge of Version Control and JSON.
3+
4+
Begenning
5+
A little info about your project and/ or overview that explains what the project is about.
6+
7+
Motivation
8+
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
9+
10+
Build status
11+
Build status of continus integration i.e. travis, appveyor etc. Ex. -
12+
13+
Build Status Windows Build Status
14+
15+
Code style
16+
If you're using any code style like xo, standard etc. That will help others while contributing to your project. Ex. -
17+
18+
js-standard-style
19+
20+
Screenshots
21+
Include logo/demo screenshot etc.
22+
23+
Tech/framework used
24+
Ex. -
25+
26+
Built with
27+
28+
Electron
29+
Features
30+
What makes your project stand out?
31+
32+
Code Example
33+
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
34+
35+
Installation
36+
Provide step by step series of examples and explanations about how to get a development env running.
37+
38+
API Reference
39+
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
40+
41+
Tests
42+
Describe and show how to run the tests with code examples.
43+
44+
How to use?
45+
If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.
46+
47+
Contribute
48+
Let people know how they can contribute into your project. A contributing guideline will be a big plus.
49+
50+
Credits
51+
Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contrbuted in this project.
52+
53+
Anything else that seems useful
54+
License
55+
A short snippet describing the license (MIT, Apache etc)
56+
57+
MIT © Yourname

0 commit comments

Comments
 (0)