Readme update

README.rst

@@ -10,10 +10,90 @@ without all of those bells and whistles Calibre has, and with cleanest more
 *pythonic* approach.
 
 
+Requirements
+------------
+
+To build and run ebook converter, you'll need:
+
+- Python 3.6 or newer
+- `Liberation fonts`_
+- setuptools
+- C compiler (yes, there is a single module, which is written in C)
+
+No Python2 support. Even if Calibre probably still is able to run on Python2, I
+do not have an intention to support it.
+
+
+What's supported
+----------------
+
+To be able to perform some optimization and make converter more reliable and
+easy to use, first I need to remove some of the features, which are totally not
+crucial in my opinion, although they might be re-added later, like, for
+instance there is no automatic language translations depending on the locale
+settings.
+
+First of all, I'm in the process of getting rid of strongly coupled things to
+QT libraries, and GUI code as well. Second, I'll try to minimize all
+modifications from third parties (external modules copied into Calibre project
+for instance), and make a huge cleanup. I'm not sure if I find time and
+strength for doing it completely, but I'll try.
+
+
+Input formats
+~~~~~~~~~~~~~
+
+Currently, I've tested following input formats:
+
+- docx
+- epub
+- LibreOffice odt
+- txt
+- Palm pdb
+- rtf
+- mobi
+
+
+Note, that old Microsoft doc format is not supported, although old documents
+can be fairly easy converted using text processors programs, lik Word or
+LibreOffice to supported formats.
+
+
+Output formats
+~~~~~~~~~~~~~~
+
+Currenlty, the only format which is supported is BBeB (lrf) mainly because it
+is the only one I care for now ;) I'm happy user of Sony PRS-505, and I have no
+zero motivation to change that reader to something more fancy. Or plastic.
+
+I'm going to enable others pretty soon.
+
+
 Installation
 ------------
 
-TBD.
+Ebook converter is somewhere in between in alpha and beta stage, therefore I
+didn't place it on `pypi`_ yet.
+
+Preferred way for installation is to use virtualenv (or any other virtualenv
+managers), i.e:
+
+.. code:: shell-session
+
+   $ virtualenv venv
+   $ . venv/bin/activate
+   (venv) $ git clone https://github.com/gryf/ebook-converter
+   (venv) $ cd ebook-converter
+   (venv) $ # you can either use pip or just setuptools:
+   (venv) $ pip install .
+   (venv) $ # OR
+   (venv) $ python setup.py install
+
+Simple as that. And from now on, you can issue converter:
+
+.. code:: shell-session
+
+   (venv) $ ebook-converter book.docx book.lrf
 
 
 License
@@ -24,3 +104,5 @@ for details.
 
 
 .. _Calibre project: https://calibre-ebook.com/
+.. _pypi: https://pypi.python.org
+.. _Liberation fonts: https://github.com/liberationfonts/liberation-fonts

setup.cfg

@@ -14,6 +14,7 @@ classifier =
     Intended Audience :: Other Audience
     License :: OSI Approved :: GNU General Public License v3 (GPLv3)
     Operating System :: POSIX :: Linux
+    Development Status :: 3 - Alpha
     Programming Language :: Python
     Programming Language :: Python :: 3
     Programming Language :: Python :: 3 :: Only
@@ -23,7 +24,7 @@ classifier =
 [options]
 packages = find:
 include_package_data = True
-install_requires = 
+install_requires =
     filelock
     python-dateutil
     lxml