## Readme.MD Beispiel GitHub Project ReadMe.md Vorlage Readme wird als erklärende Datei verwendet, und der Zweck ist es, den Zuschauern das Projekt schnell und die Vogelperspektive zu verstehen. Um dies zu tun, sollten Sie beim Schreiben von Readme auf die Hierarchie und das Format achten, und es ist am besten, mit Markdown zu schreiben. Im Allgemeinen enthält es mindestens drei Teile. Die erste besteht darin, den Projekthintergrund und die Verwendung des Projekts einzuführen. Die zweite besteht darin, Methoden (einschließlich Import/Installation, exponierte Anrufoberflächen usw.) zu verwenden, und die dritte besteht darin, das Protokoll einzuhalten. PS (Es scheint, dass wir Anfänger nicht so High-End schreiben müssen.
Personal: Lixinyi, LXY, WXM, LHZ, SH ## Github -Adresse https://github.com/tanelmer/hisuncle ## Demo -Adresse http://webcafe.pub/ife/stage1/ ## Github Project Readme.md Vorlagen
#### Beispiel:
Hier sind die Fälle, in denen das Projekt verwendet wird. Sie können den APK -Download -Link oder einfach ein paar Screenshots einstellen.
(Das Beispiel wird von Anfang an freigesetzt, damit der Betrachter auf einen Blick erkennen kann, ob er nach etwas sucht, nach dem er sucht)
### Funktionen (optional)
Feature a
Feature b
### Prinzip Beschreibung (optional) Erklären Sie, auf welche Ideen das Projekt basierend auf
Gradle:
compile 'xxx'(Erläutern Sie die Projektkonfigurationsmethode, und die Android Open Source -Bibliothek wird mit Gradle importiert.)
### Wie man es benutzt, welche Schritte sind die Schritte und welche Schnittstellen gibt es.
Zum Beispiel Verschmutzungsmethoden usw.
### Todo (optional) Der nächste Entwicklungs-/Wartungsplan.
Einhaltung der Vereinbarung
Dateien ignorieren