meutel/bouquins-ror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Meutel 2015-06-28 20:11:09 +02:00
parent 912e347294
commit ee56518217
2 changed files with 13 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md Normal file
View File

@ -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).

28
README.rdoc
View File

@ -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
<tt>rake doc:app</tt>.