diff options
| author | Nguyễn Gia Phong <mcsinyx@disroot.org> | 2022-06-28 15:27:06 +0900 |
|---|---|---|
| committer | Nguyễn Gia Phong <mcsinyx@disroot.org> | 2022-06-28 15:27:06 +0900 |
| commit | 5ba68fae053ccabc3161ee4f80963ac0c47ddaf2 (patch) | |
| tree | 83eb374a71de46ccb8ec17b803976b9a5e11bb2e /README.md | |
| parent | e405d3f244d074f00658e020795a90ec3f69add7 (diff) | |
| download | phylactery-0.1.0.tar.gz | |
Polish up for a release 0.1.0
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md index bf38a86..dac8e3f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ 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 @@ -15,4 +25,5 @@ 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 [agplv3]: https://www.gnu.org/licenses/agpl-3.0.html |