From 17d0eef18829a5ffb0883e7a567ca44c66799e16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lucas?= Date: Sun, 14 Feb 2016 20:27:21 +0100 Subject: [PATCH] chore: Switch README to markdown --- README | 36 +++++++++++++++++++++--------------- 1 file changed, 21 insertions(+), 15 deletions(-) diff --git a/README b/README index b030b4c..2f325aa 100644 --- a/README +++ b/README @@ -1,11 +1,20 @@ -= COPS = +# COPS COPS stands for Calibre OPDS (and HTML) Php Server. -COPS output is valid the unofficial OPDS validator : -http://opds-validator.appspot.com/ +See : [COPS's home](http://blog.slucas.fr/en/oss/calibre-opds-php-server) for more details. -= 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 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. -= Prerequisites = +# Prerequisites 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. @@ -42,7 +51,7 @@ On any Debian base Linux you can use : On Centos you may have to add : yum install php-xml -= Install = +# Install 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 @@ -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 : 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 -= Need help = +# Need help Please read https://github.com/seblucas/cops/wiki and check the FAQ. -= Disclaimer = - -It's tested by me and many other users but there's still some little bugs around ;) - -= Credits = +# Credits * 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 * 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. * 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 * js-lru : https://github.com/rsms/js-lru -= Copyright & License = +# Copyright & License COPS - 2012-2016 (c) Sébastien Lucas