From 1c40436835571b6fb2499e37848305922dd241c9 Mon Sep 17 00:00:00 2001 From: Elizaveta Lutsenko <skystar-el@yandex.ru> Date: Tue, 17 Jan 2023 18:02:24 +0300 Subject: [PATCH] Update create_multilang_readme_files.md --- create_multilang_readme_files.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/create_multilang_readme_files.md b/create_multilang_readme_files.md index e6848e6..5ef2dda 100644 --- a/create_multilang_readme_files.md +++ b/create_multilang_readme_files.md @@ -3,15 +3,29 @@ - Создать readme файл на оÑновном Ñзыке, например на руÑÑком `README.rst` - Создать readme файл на другом Ñзыке, например на английÑком `README_en.rst` - Создать директорию `.github` в корне Ñ€ÐµÐ¿Ð¾Ð·Ð¸Ñ‚Ð¾Ñ€Ð¸Ñ -- Создать ÑÑылку на `README_en.rst` в `.github`: -``` -cd .github -ln -s /path/to/README_en.rst README.rst -``` -- ЕÑли проект из Ñ€ÐµÐ¿Ð¾Ð·Ð¸Ñ‚Ð¾Ñ€Ð¸Ñ Ð·Ð°Ð³Ñ€ÑƒÐ¶Ð°ÐµÑ‚ÑÑ Ð½Ð° PyPI, нужно Ñкорректировать путь к readme файлу, который будет иÑпользовать PyPI, в `/setup.py` в переменной `long_description` -- Добавить в git `/.github/README.rst` +- Создать ÑÑылку на `README_en.rst` в `.github` + * Ðа Linux: + ``` + cd .github + ln -s path/to/README_en.rst README.rst + ``` + * Ðа Windows: + - открыть git конÑоль (например в IDE) и перейти в корень проекта + - выполнить команду: + ``` + git config core.symlinks true + ``` + - запуÑтить `cmd.exe` от имени админиÑтратора и перейти в корень проекта + - выполнить команды: + ``` + cd .github + mklink README.rst path\to\README_en.rst + ``` + +- ЕÑли проект из Ñ€ÐµÐ¿Ð¾Ð·Ð¸Ñ‚Ð¾Ñ€Ð¸Ñ Ð·Ð°Ð³Ñ€ÑƒÐ¶Ð°ÐµÑ‚ÑÑ Ð½Ð° PyPI, нужно Ñкорректировать путь к readme файлу, который будет иÑпользовать PyPI, в `setup.py` в переменной `long_description` +- Добавить в git `.github/README.rst` - Сделать commit и push -GitHub будет иÑкать readme Ñначала в папке `/.github`, найдет и выведет `/.github/README.rst`. Он в Ñвою очередь будет указывать на `README_en.rst`. +GitHub будет иÑкать readme Ñначала в папке `.github`, найдет и выведет `.github/README.rst`. Он в Ñвою очередь будет указывать на `README_en.rst`. ЕÑли еÑть mirror Ñ€ÐµÐ¿Ð¾Ð·Ð¸Ñ‚Ð¾Ñ€Ð¸Ñ (например на GitLab), то там на главной Ñтранице будет выводитьÑÑ readme файл на оÑновном Ñзыке, Ñ‚.е. `README.rst`. -- GitLab