No Description

Adam ec0097a6dd Merge branch 'v0.4.0' 10 months ago
accounts 9246e63ecc show error description in signup 1 year ago
config 0e34b26843 move TMDB API key to config 11 months ago
datastructure 311a054f2c get article title for books from Inventaire 1 year ago
db af9bffd10e show page i of N in lists 10 months ago
front 4bfa20dcbc not panic when default language is not a symbolic link 11 months ago
i18n 4bfa20dcbc not panic when default language is not a symbolic link 11 months ago
inventaire 311a054f2c get article title for books from Inventaire 1 year ago
libamuse 88ea87016a not use outside service for empty avatar 11 months ago
network e3b342815f check http code 304 only if there was no error 11 months ago
static 827b5a79a3 set images width and height in front 10 months ago
templates ea2cb9fa0f update version 10 months ago
tmdb 0e34b26843 move TMDB API key to config 11 months ago
wikidata f63b623ec5 show book and bookserie native title if label is empty 11 months ago
.gitignore a9944d1f7c cache films’ responses 1 year ago
CHANGELOG.adoc ea2cb9fa0f update version 10 months ago
LICENSE 0d1d834b61 add license 1 year ago
README.adoc ea2cb9fa0f update version 10 months ago
example.toml c7bdc51bd9 add configuration to readme 10 months ago
go.mod e28218c299 meta tidy up 11 months ago
go.sum e28218c299 meta tidy up 11 months ago
main.go c8c3d9ba05 validate state before running 11 months ago
mkfile e28218c299 meta tidy up 11 months ago
router.go 14184a50d7 add address to config 11 months ago

README.adoc

= a·muse
apiote
v0.4.0 (Dish of the Day) 2020-11-25
:toc:

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.

== Name

The name of the system is ‘a·muse.’ The name of the program, command, any package is ‘amuse.’

Both are pronounced the same–[æˈʔmjuːz].

It’s a play of words—‘amuse’ as a verb, and ‘a muse’ as a goddess.

== Building

To build version 0.3.x, You need:

* `go>=1.11`
* `resvg`
* `cwebp`
* `mk`

Then, all You have to do is run `mk`, and—optionally—`mk install`

== Configuration

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 patches (send patches to `git@apiote.tk`).

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.

== Roadmap

Roadmap exists inside `CHANGELOG.adoc`.

Recommendations have been removed from the Roadmap.
API has been postponed till the project is more stable.

== Licence

----
amuse Copyright (C) 2019–2020 apiote

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
----