add info to the doc index

This commit is contained in:
Izalia Mae 2024-03-20 12:04:57 -04:00
parent b0b6790daf
commit 5d4ed3dd6c
2 changed files with 44 additions and 2 deletions

2
dev.py
View file

@ -42,7 +42,7 @@ def cli():
@cli.command("clean")
def cli_clean():
for directory in {"build", "dist", "gemi_python.egg-info"}:
for directory in {"build", "dist", "dist-pypi", "gemi_python.egg-info"}:
try:
shutil.rmtree(directory)

View file

@ -1,4 +1,46 @@
Welcome to Gemi's documentation
================================
Gemi is a utility module for the Gemini protocol
Gemi is a utility module for the Gemini protocol.
.. note:: Docs are a WIP
Installation
------------
.. parsed-literal::
python3 -m pip install gemi-python==\ |release|
Scripts
-------
There are two small utilities that come with Gemi. ``gemi.client`` or ``~/.local/bin/gurl`` fetches
a resource at the specified gemini url and ``gemi.server`` or ``~/.local/bin/gemi-server`` serves
a directory over the gemini protocol.
Systemd Service
---------------
``/etc/systemd/system/gemi-server.service``
.. code-block:: ini
[Unit]
Description=Gemi Server
After=network.target
[Service]
Type=simple
DynamicUser=yes
ExecStart=/usr/local/bin/gemi-server --config-dir /var/lib/gemi-server
StateDirectory=gemi-server
TimeoutSec=15
Restart=always
[Install]
WantedBy=multi-user.target