Каковы хорошие практики для локализованных README?
Иногда необходимо сделать файлы README доступными на нескольких языках в проекте, размещенном в GitLab, GitHub, BitBucket и т. Д. В этом проекте автор (ы) создал основной README.md на английском, наряду с другими README-<lang>.md файлы.
Есть ли рекомендуемые хорошие практики для этого?
1 ответ
Шаблон для хорошего README.md
Код
# Project Title
One Paragraph of project description goes here
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
What things you need to install the software and how to install them
```
Give examples
```
### Installing
A step by step series of examples that tell you how to get a development env running
Say what the step will be
```
Give the example
```
And repeat
```
until finished
```
End with an example of getting some data out of the system or using it for a little demo
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
See also the list of [contributors](https://github.com/your/project/contributors) who participated in this project.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
## Acknowledgments
* Hat tip to anyone whose code was used
* Inspiration
* etc
Как видите
Название Проекта
Один абзац описания проекта находится здесь
Начиная
Эти инструкции предоставят вам копию проекта, которая будет запущена на вашем локальном компьютере для целей разработки и тестирования. См. Развертывание для заметок о том, как развернуть проект в работающей системе.
Предпосылки
Что нужно для установки программного обеспечения и как их установить
Give examples
Установка
Пошаговая серия примеров, в которых рассказывается, как запустить среду разработки
Скажи, какой будет шаг
Give the example
И повторить
until finished
Завершите пример получения некоторых данных из системы или использования их для небольшой демонстрации
Запуск тестов
Объясните, как запустить автоматизированные тесты для этой системы
Разбить в конец до конца испытаний
Объясните, что тестируют эти тесты и почему
Give an example
И тесты стиля кодирования
Объясните, что тестируют эти тесты и почему
Give an example
развертывание
Добавьте дополнительные заметки о том, как развернуть это в реальной системе
Построен с
- Dropwizard - используемый веб-фреймворк
- Maven - Управление зависимостями
- РИМ - Используется для создания RSS-каналов
Содействие
Пожалуйста, прочитайте CONTRIBUTING.md для получения подробной информации о нашем кодексе поведения и процедуре отправки нам запросов на извлечение информации.
Versioning
Мы используем SemVer для управления версиями. Доступные версии см. В тегах этого хранилища.
Авторы
- Билли Томпсон - Начальная работа - PurpleBooth
Смотрите также список участников, которые участвовали в этом проекте.
Лицензия
Этот проект лицензирован по лицензии MIT - подробности см. В файле LICENSE.md
Подтверждения
- Шляпа для всех, чей код был использован
- вдохновение
- так далее