diff --git a/Readme.md b/README.md similarity index 99% rename from Readme.md rename to README.md index 7cb617e4b..94c337cc0 100644 --- a/Readme.md +++ b/README.md @@ -1,11 +1,6 @@ - # CryptPad Documentation - - ## Installation - Using [Poetry](https://python-poetry.org/docs/) - ```bash poetry install ``` @@ -22,7 +17,6 @@ poetry export -f requirements.txt --output requirements.txt ``` ## Build - English `en` is the default language. to build the default: @@ -38,7 +32,6 @@ make -e SPHINXOPTS="-D language='fr'" html View the result in `/_build/html/` ## Translations - If you are interested in translating this documentation, you can use our [Weblate project](https://weblate.cryptpad.org/projects/user-guide/) for the user guide. If your language is not listed, please [contact the development team](https://cryptpad.fr/contact.html) to add it. To add a new language @@ -47,9 +40,7 @@ sphinx-intl update --pot-dir _build/gettext -l de ``` change `de` to the locale you want to add - ### Translated builds - To update after default language has changed: ```bash sphinx-intl update -p _build/locale` @@ -72,7 +63,6 @@ sphinx-intl update -p _build/gettext -l fr ``` ### Adding a language - 1. add language code to `LANG` and leave an empty line at the end of the file 2. add the `