Personal/cops
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

chore: Switch README to markdown

Browse source
This commit is contained in:
Sébastien Lucas 2016-02-14 20:27:21 +01:00
parent 8cdaa47a41
commit 17d0eef188
1 changed files with 21 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README
View file

@ -1,11 +1,20 @@
= COPS = # COPS
COPS stands for Calibre OPDS (and HTML) Php Server. COPS stands for Calibre OPDS (and HTML) Php Server.
COPS output is valid the unofficial OPDS validator : See : [COPS's home](http://blog.slucas.fr/en/oss/calibre-opds-php-server) for more details.
http://opds-validator.appspot.com/
= Why ? = Don't forget to check the [Wiki](https://github.com/seblucas/cops/wiki).
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/seblucas/cops/badges/quality-score.png?s=e1c87a92ef90b8d666cd9bd4f3612bd10db84364)](https://scrutinizer-ci.com/g/seblucas/cops/)
[![Code Coverage](https://scrutinizer-ci.com/g/seblucas/cops/badges/coverage.png?s=1e21d8c3bf96d7b0b7cc0e54429fa897ddea1506)](https://scrutinizer-ci.com/g/seblucas/cops/)
[![Build Status](https://travis-ci.org/seblucas/cops.png)](https://travis-ci.org/seblucas/cops)
[![Selenium Test Status](https://saucelabs.com/browser-matrix/seblucas.svg)](https://saucelabs.com/u/seblucas)
# Why ?
In my opinion Calibre is a marvelous tool but is too big and has too much In my opinion Calibre is a marvelous tool but is too big and has too much
dependencies to be used for its content server. dependencies to be used for its content server.
@ -28,7 +37,7 @@ So COPS's main advantages are :
If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL. If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL.
= Prerequisites = # Prerequisites
1. PHP 5.3, 5.4, 5.5, 5.6 or hhvm with GD image processing, Libxml, Intl, Json & SQLite3 support. 1. PHP 5.3, 5.4, 5.5, 5.6 or hhvm with GD image processing, Libxml, Intl, Json & SQLite3 support.
2. A web server with PHP support. I only tested with various version of Nginx. 2. A web server with PHP support. I only tested with various version of Nginx.
@ -42,7 +51,7 @@ On any Debian base Linux you can use :
On Centos you may have to add : On Centos you may have to add :
yum install php-xml yum install php-xml
= Install = # Install
1. Extract the zip file to a folder in web space (visible to the web server). 1. Extract the zip file to a folder in web space (visible to the web server).
2. If you're doing a first-time install, copy config_local.php.example to config_local.php 2. If you're doing a first-time install, copy config_local.php.example to config_local.php
@ -53,25 +62,22 @@ If you choose to put your Calibre directory inside your web directory then you
will have to edit /etc/nginx/mime.types to add this line : will have to edit /etc/nginx/mime.types to add this line :
application/epub+zip epub; application/epub+zip epub;
= Known problems = # Known problems
Not a lot ;) Not a lot, except for the bad quality of the code (first PHP project ever) ;)
Please see https://github.com/seblucas/cops/issues for open issues Please see https://github.com/seblucas/cops/issues for open issues
= Need help = # Need help
Please read https://github.com/seblucas/cops/wiki and check the FAQ. Please read https://github.com/seblucas/cops/wiki and check the FAQ.
= Disclaimer = # Credits
It's tested by me and many other users but there's still some little bugs around ;)
= Credits =
* Locale message handling is inspired of http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/ * Locale message handling is inspired of http://www.mind-it.info/2010/02/22/a-simple-approach-to-localization-in-php/
* str_format function come from http://tmont.com/blargh/2010/1/string-format-in-php * str_format function come from http://tmont.com/blargh/2010/1/string-format-in-php
* All icons come from Font Awesome : http://fontawesome.github.io/Font-Awesome/ * All icons come from Font Awesome : http://fontawesome.github.io/Font-Awesome/
* The unofficial OPDS validator : http://opds-validator.appspot.com/
* Thanks to all testers, translators and contributors. * Thanks to all testers, translators and contributors.
* Feed icons made by Freepik from Flaticon website licensed under Creative Commons BY 3.0 http://www.flaticon.com and http://www.freepik.com * Feed icons made by Freepik from Flaticon website licensed under Creative Commons BY 3.0 http://www.flaticon.com and http://www.freepik.com
@ -85,7 +91,7 @@ External libraries used :
* PHPMailer : https://github.com/PHPMailer/PHPMailer * PHPMailer : https://github.com/PHPMailer/PHPMailer
* js-lru : https://github.com/rsms/js-lru * js-lru : https://github.com/rsms/js-lru
= Copyright & License = # Copyright & License
COPS - 2012-2016 (c) Sébastien Lucas <sebastien@slucas.fr> COPS - 2012-2016 (c) Sébastien Lucas <sebastien@slucas.fr>