diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..38e5d57 --- /dev/null +++ b/README.rst @@ -0,0 +1,53 @@ +================================== + cherrylesana - a lesana frontend +================================== + +lesana_ is a python3 library to organize collections of various kinds. +It is designed to have a data storage / serialization format that is +friendly to git and other VCSs, but decent performances. + +.. _lesana: https://lesana.trueelena.org/ + +cherrylesana is a frontend to lesana that uses cherrypy_ to run a local +server and provide an html based interface. + +.. _cherrypy: http://cherrypy.org/ + +This is still very much work in progress and functionality *will* +change. + +Installation +------------ + +lesana expects to run on a POSIX-like system and requires the following +dependencies: + +* python3 +* lesana_ +* `guacamole <https://github.com/zyga/guacamole/>`_ +* CherryPy_ +* `jinja2 <http://jinja.pocoo.org/>`_ + +Under debian (and derivatives), the packages to install are:: + + apt install python3-guacamole python3-jinja2 python3-cherrypy3 + +plus lesana, currently not yet in debian. + +License +------- + +Copyright (C) 2016-2017 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 +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see <http://www.gnu.org/licenses/>. |