aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: 38e5d57b20e2446b6c68efb362811b5c884088cb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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/>.