summaryrefslogtreecommitdiffstatshomepage
path: root/docs/index.rst
diff options
context:
space:
mode:
authorWolfgang Müller2024-03-05 18:08:09 +0100
committerWolfgang Müller2024-03-05 19:25:59 +0100
commitd1d654ebac2d51e3841675faeb56480e440f622f (patch)
tree56ef123c1a15a10dfd90836e4038e27efde950c6 /docs/index.rst
downloadhircine-0.1.0.tar.gz
Initial commit0.1.0
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..ac62829
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,38 @@
+Intro
+=====
+
+**hircine** [#f1]_ is a web-based comic organizer written in `Python
+<https://www.python.org>`_ and `SvelteKit <https://kit.svelte.dev>`_.
+
+.. image:: /_images/comics.jpg
+ :align: center
+ :alt: An overview of comics
+
+It imports image files from *ZIP* archives, supports a wide range of metadata
+including custom tags and namespaces, comes with a powerful filtering system,
+and keeps its own object store of processed and deduplicated image files for
+easy and fast access via the browser. This is done without ever modifying any
+source archives so you can keep your collection in pristine condition.
+
+**hircine** contains a simple reader interface that supports per-comic page
+layouts and includes an extensible scraper framework that allows easy importing
+of metadata from local files or online sources.
+
+.. toctree::
+ :maxdepth: 2
+
+ overview
+ setup
+ usage/index
+ advanced/index
+ plugins/index
+ glossary
+ changelog
+ about
+ git repository <https://git.oriole.systems/hircine/>
+
+|
+
+.. rubric:: Footnotes
+
+.. [#f1] Oxford English Dictionary, 2nd Edition: (ˈhɜːsaɪn) [ad. L. hircīnus (hirquīnus) of a goat; having a goatish smell.]