diff --git a/HACKING.md b/HACKING.md new file mode 100644 index 0000000..6b33554 --- /dev/null +++ b/HACKING.md @@ -0,0 +1,33 @@ +# Blueprint files + +When adding a new Blueprint file in `data/res/`, remember to add it to both, the +list of bluprint sources in `data/res/meson.build` and the list of resources in +`data/res/musicus.gresource.xml` (`.blp` replaced with `.ui`). + +# Internationalization + +Execute the following commands from the project root directory to update +translation files whenever translatable strings have been changed. + +1. Update `template.pot` + + ```bash + xgettext \ + --from-code=UTF-8 \ + --add-comments \ + --keyword=_ \ + --keyword=C_:1c,2 \ + --files-from=po/POTFILES \ + --output=po/template.pot + ``` + +2. Update translation files + + ```bash + msgmerge \ + --update \ + --backup=off \ + --no-fuzzy-matching \ + po/de.po \ + po/template.pot + ``` \ No newline at end of file diff --git a/README.md b/README.md index 313d36e..44b95b8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ -# musicus +# Musicus -A description of this project. +The classical music player and organizer. + +## Hacking + +See [HACKING.md](HACKING.md) for useful information on developing Musicus. diff --git a/po/HACKING.md b/po/HACKING.md deleted file mode 100644 index 153c33b..0000000 --- a/po/HACKING.md +++ /dev/null @@ -1,27 +0,0 @@ -# Internationalization - -Execute the following commands from the project root directory to update -translation files whenever translatable strings have been changed. - -## 1. Update `template.pot` - -```bash -xgettext \ - --from-code=UTF-8 \ - --add-comments \ - --keyword=_ \ - --keyword=C_:1c,2 \ - --files-from=po/POTFILES \ - --output=po/template.pot -``` - -## 2. Update translation files - -```bash -msgmerge \ - --update \ - --backup=off \ - --no-fuzzy-matching \ - po/de.po \ - po/template.pot -``` \ No newline at end of file