diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | README.rst | 9 | ||||
| -rw-r--r-- | docs/.gitignore | 1 | ||||
| -rw-r--r-- | docs/source/index.rst | 14 |
4 files changed, 20 insertions, 6 deletions
@@ -1,2 +1,4 @@ *.pyc .coverage + +.*.sw? @@ -25,6 +25,10 @@ by simply writing a personalized ``settings.yaml``. Installation ------------ +The source code for lesana can be downloaded from the git repository at +https://git.trueelena.org/cgit.cgi/software/lesana/; releases are made +on `pypi <https://pypi.org/project/lesana/>`_. + lesana expects to run on a POSIX-like system and requires the following dependencies: @@ -39,9 +43,6 @@ Under debian (and derivatives), the packages to install are:: apt install python3-jinja2 python3-ruamel.yaml python3-xapian python3-git -(some of those are only available on stretch+ because earlier -versions lacked python3 support.) - lesana can be run in place from the git checkout / extracted tarball; to use ``setup.py`` you will also need setuptools (e.g. from the ``python3-setuptools`` package under debian and derivatives). @@ -49,7 +50,7 @@ use ``setup.py`` you will also need setuptools (e.g. from the License ------- -Copyright (C) 2016-2019 Elena Grandi +Copyright (C) 2016-2020 Elena Grandi This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build diff --git a/docs/source/index.rst b/docs/source/index.rst index 292a0ce..fe3c821 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,8 +3,18 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to lesana's documentation! -================================== +.. include:: ../../README.rst + +Documentation +------------- + +The documentation for the latest development version of lesana can be +browsed online at https://lesana.trueelena.org; `PDF +<https://lesana.trueelena.org/lesana.pdf>`_ and `epub +<https://lesana.trueelena.org/lesana.epub>`_ versions are also +available. + +The author can be contacted via email: webmaster AT trueelena DOT org. .. toctree:: :maxdepth: 2 |