summary refs log tree commit diff homepage
path: root/README.md
blob: c98f657c0051aaa03df402d84bbfa975c04d7a87 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# Phylactery

Phylactery is a web server rendering comic books directly from ZIP archives.

## Installation

    go build -o $prefix/bin/phylactery main.go

## Usage

Set environment variables `PHYLACTERY_LIBRARY` to where
the [comic book archives] are stored and `PHYLACTERY_ADDRESS`
to the listening address and run `phylactery`.

## Hacking

    PHYLACTERY_LIBRARY=/path/to/library PHYLACTERY_ADDRESS=:42069 go run main.go

## Contributing

Patches should be sent to [~cnx/loang@lists.sr.ht][loang mailing list]
using [`git send-email`][git send-email], with the following configuration:

    git config sendemail.to '~cnx/loang@lists.sr.ht'
    git config format.subjectPrefix 'PATCH phylactery'

## Copying

![AGPLv3](https://www.gnu.org/graphics/agplv3-155x51.png)

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

[comic book archives]: https://en.wikipedia.org/wiki/Comic_book_archive
[loang mailing list]: https://lists.sr.ht/~cnx/loang
[git send-email]: https://git-send-email.io
[agplv3]: https://www.gnu.org/licenses/agpl-3.0.html