From 9e0ff2a3d49f07feb3764d53b7b9c31ed71fd9f2 Mon Sep 17 00:00:00 2001 From: Georg krause <mail@georg-krause.net> Date: Tue, 4 Apr 2023 13:12:22 +0200 Subject: [PATCH] docs: Adjust Readme to show new commands, add some more to the Makefile --- Makefile | 6 ++++++ README.md | 33 ++++++++++++++++++++++----------- 2 files changed, 28 insertions(+), 11 deletions(-) diff --git a/Makefile b/Makefile index fc93243b..7ed70722 100644 --- a/Makefile +++ b/Makefile @@ -95,3 +95,9 @@ i18n_extract: i18n_compile: poetry run pybabel compile -f --directory translations/ --domain messages + +test: + poetry run pytest test_ns.py + +lint: + poetry run djlint --reformat . diff --git a/README.md b/README.md index 39199673..5a4903c7 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,42 @@ # funkwhale.audio ## Project setup -``` -# Dependencies for internationalization -apt-get install gettext jq -yarn install -``` + +In order to develop for the website, you need to have the following packages installed: + +- poetry +- make ### Compiles and hot-reloads for development ``` -yarn run serve +make devserver ``` ### Compiles and minifies for production ``` -yarn run build +make publish ``` ### Run your tests ``` -yarn run test +make test ``` ### Lints and fixes files ``` -yarn run lint +make lint +``` + +### Translations + +To extract the strings from the source files, run + +``` +make i18n_extract ``` -### Customize configuration -See [Configuration Reference](https://cli.vuejs.org/config/). +Before publishing, the translations need to be compiled: + +``` +make i18n_compile +``` -- GitLab