README.adoc 2.4 KB

  1. = a·muse
  2. apiote <>
  3. v0.4.0 (Dish of the Day) 2020-11-25
  4. :toc:
  5. a·muse is a no-JavaScript frontend for The Movie Database. It is also a system that connects films with books which the former are based on, thanks to using data from Wikidata. Finally, a·muse is also a place to collect ideas which films, books, and series watch or read next, and which of those have already been watched or read.
  6. == Name
  7. The name of the system is ‘a·muse.’ The name of the program, command, any package is ‘amuse.’
  8. Both are pronounced the same–[æˈʔmjuːz].
  9. It’s a play of words—‘amuse’ as a verb, and ‘a muse’ as a goddess.
  10. == Building
  11. To build version 0.3.x, You need:
  12. * `go>=1.11`
  13. * `resvg`
  14. * `cwebp`
  15. * `mk`
  16. Then, all You have to do is run `mk`, and—optionally—`mk install`
  17. == Configuration
  18. 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`
  19. == Contribute
  20. Contributions are welcome either as patches (send patches to ``).
  21. 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.
  22. This project uses[nvie’s branching model]. Please request merges to `develop` branch.
  23. == Roadmap
  24. Roadmap exists inside `CHANGELOG.adoc`.
  25. Recommendations have been removed from the Roadmap.
  26. API has been postponed till the project is more stable.
  27. == Licence
  28. ----
  29. amuse Copyright (C) 2019–2020 apiote
  30. This program is free software: you can redistribute it and/or modify
  31. it under the terms of the GNU Affero General Public License as published by
  32. the Free Software Foundation, either version 3 of the License, or
  33. (at your option) any later version.
  34. This program is distributed in the hope that it will be useful,
  35. but WITHOUT ANY WARRANTY; without even the implied warranty of
  37. GNU Affero General Public License for more details.
  38. You should have received a copy of the GNU Affero General Public License
  39. along with this program. If not, see <>.
  40. ----