Оформление github

[iLoco]

Знающие, помоги с оформлением гита под SP плагины, что нужно указывать в README и как правильнее и более подробно подать информацию о плагине пользователям? А так-же как лучше располагать файлы в нём и на каком языке лучше оформлять?

В наличии:
- гиф превьюшки о чём обще плагин (по несколько штук)
- фотографии (скрины из игры)
- конфиги настроек, если есть (по хорошему, сделать бы в стиле выпадающего списка)
- список переменных, если есть (по хорошему, сделать бы в стиле выпадающего списка)
- список конваров, если есть (по хорошему, сделать бы в стиле выпадающего списка)
- ссылка на киви/приват24 для доната/поддержки автора
- callback ссылки

 

[Grey83]

Basic writing and formatting syntax - GitHub Docs

Create sophisticated formatting for your prose and code on GitHub with simple syntax.

help.github.com