Author: Adam <git@apiote.tk>
add configuration to readme
README.adoc | 8 ++++---- example.toml | 5 +++++
diff --git a/README.adoc b/README.adoc index 4c4e0c57cb2c40ee7e79036cf8ce63c6a5b5cea9..cbe3fd8210d6267e4729abe1dc64ac3c3d6e513b 100644 --- a/README.adoc +++ b/README.adoc @@ -24,15 +24,15 @@ * `mk` Then, all You have to do is run `mk`, and—optionally—`mk install` -=== Python router +== Configuration -WARNING: Python router is deprecated +a·muse can be configured with command line arguments or with configuration file. Example configuration file can be found in `example.toml`. The only mandatory field is `TmdbApiKey` == Contribute -Contributions are welcome either as merge requests or patches (send patches to `git@apiote.tk`). +Contributions are welcome either as patches (send patches to `git@apiote.tk`). -If You want to translate a·muse, translate strings in `i18n/default.toml` and request merge, send patch, or share the translated file in any other way. The translated file must be named `tag.toml`, where `tag` is the language tag of the translation. Translations don’t have to be full; a·muse falls back to default (en-GB) when strings are missing. +If You want to translate a·muse, translate strings in `i18n/default.toml` and send patch, or share the translated file in any other way. The translated file must be named `tag.toml`, where `tag` is the language tag of the translation. Translations don’t have to be full; a·muse falls back to default (en-GB) when strings are missing. This project uses https://nvie.com/posts/a-successful-git-branching-model/[nvie’s branching model]. Please request merges to `develop` branch. diff --git a/example.toml b/example.toml new file mode 100644 index 0000000000000000000000000000000000000000..28f42f0d398c4d8addb23d1bb676782c8308c27d --- /dev/null +++ b/example.toml @@ -0,0 +1,5 @@ +OpenRegistration = true +Address = 127.0.0.1 +Port = 5008 +DataHome = /usr/share/amuse +TmdbApiKey = deadbeef