##README.md Sample Github project README.md template README is used as an explanatory file, and the purpose is to allow viewers to understand the project quickly and bird's eye view. In order to do this, you should pay attention to the hierarchy and format when writing README, and it is best to write with Markdown. Generally, it contains at least three parts. The first is to introduce the project background and uses, the second is to use methods (including import/installation, exposed calling interfaces, etc.), and the third is to comply with the protocol. PS (It seems that we novices don’t need to write such high-end =. =) For details, you can refer to this template, which has been placed on Github.
Personnel: lixinyi, lxy, wxm, lhz, sh ##Github address https://github.com/Tanelmer/HisUncle ##demo address http://webcafe.pub/ife/stage1/ ##Github project README.md template
#### Example:
Here are the cases where the project is used. You can put the APK download link or simply put a few screenshots.
(The example is released from the beginning, so that the viewer can tell at a glance whether he is looking for something he is looking for)
### Features (optional)
Feature A
Feature B
###Principle Description (optional) Explain what ideas the project is designed based on
Gradle:
compile 'xxx'(Explain the project configuration method, and Android open source library is imported with Gradle)
###How to use it, what are the steps and what interfaces are there.
For example, obfuscation methods, etc.
###TODO (optional) The next development/maintenance plan.
Complied with the Agreement
Ignore files