Improved README description and installation instructions

This commit is contained in:
giomba 2018-11-03 16:58:40 +01:00
parent 9c751f97c5
commit a5c52223dd
2 changed files with 26 additions and 3 deletions

3
README
View File

@ -1,3 +0,0 @@
TPDF - Tellico Parser anD Finder
A simple Tellico XML parser and finder for your book library, written in Python3

26
README.md Normal file
View File

@ -0,0 +1,26 @@
# TPDF - Tellico Parser anD Finder
A simple Tellico XML archive parser and finder for your book library, written in Python3.
TPDF runs as a web application via CGI (Common Gateway Interface).
## Install
### Apache
1. Modules needed (install and enable)
```
mod_env
cgi
cgid
```
2. Environment variables (add to virtualhost or htaccess)
```
SetEnv LANG en_US.UTF-8
```
3. Clone this repository in a directory inside your webserver document root
4. Pay attention to possible data leaks throught *output* directory
### other webservers
Should work, but not tested.
## Bugs
File bug report to GOLEM Linux Users Group [golem.linux.it](http://)