## readme.md -образец проекта Github Readme.md Шаблон Readme используется в качестве объяснительного файла, и цель состоит в том, чтобы позволить зрителям быстро понять проект и взгляд на птичьего глаза. Чтобы сделать это, вы должны обратить внимание на иерархию и формат при написании Readme, и лучше всего писать с помощью Marckdown. Как правило, он содержит как минимум три части. Первое - это ввести фон проекта и использование, вторым является использование методов (включая импорт/установку, открытые вызова интерфейсы и т. Д.), А третьим - соответствовать протоколу. PS (кажется, что нам, новичкам, не нужно писать такой высококачественный =. =) Для деталей, вы можете обратиться к этому шаблону, который был размещен на GitHub.
Персонал: Lixinyi, Lxy, WXM, LHZ, SH ## github Address https://github.com/tanelmer/hisuncle ## демо -адрес http://webcafe.pub/ife/stage1/ ## github Project Readme.md Template
#### Пример:
Вот случаи, когда проект используется. Вы можете поместить ссылку на загрузку APK или просто поместить несколько скриншотов.
(Пример выходит с самого начала, так что зритель может сразу же сказать, ищет ли он что -то, что он ищет)
### функции (необязательно)
Функция а
Функция б
### Принцип Описание (необязательно) Объясните, какие идеи проект разработан на основе
Градл:
compile 'xxx'(Объясните метод конфигурации проекта, а библиотека с открытым исходным кодом Android импортируется с Gradle)
### Как его использовать, каковы шаги и какие есть интерфейсы.
Например, методы запутывания и т. Д.
### todo (необязательно) Следующий план разработки/технического обслуживания.
Соответствовал соглашению
Игнорировать файлы