diff --git a/README.md b/README.md new file mode 100644 index 0000000..ad45f0a --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +bouquins-ror +============ + +Web frontend for calibre e-book manager. + +Features +======== + +Bouquins is a Ruby On Rails application. The web UI uses bootstrap. + +It allows to browse, search and download e-books from a calibre library using a web browser (desktop/mobile). + +It needs a local access to all files in the calibre library (including the sqlite database file: metadata.db). Synchronisation of those files on the server is not part of the application (personnaly I use owncloud). diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index dd4e97e..0000000 --- a/README.rdoc +++ /dev/null @@ -1,28 +0,0 @@ -== README - -This README would normally document whatever steps are necessary to get the -application up and running. - -Things you may want to cover: - -* Ruby version - -* System dependencies - -* Configuration - -* Database creation - -* Database initialization - -* How to run the test suite - -* Services (job queues, cache servers, search engines, etc.) - -* Deployment instructions - -* ... - - -Please feel free to use a different markup language if you do not plan to run -rake doc:app.