Docs: Update TODO

[m_librarian.git] / docs / before_begin.rst

diff --git a/docs/before_begin.rst b/docs/before_begin.rst
index adc1a2c084692528e4837827f30d07fdbcf2a296..ea7fb9a0705fca06657c71d4af8389143f22957a 100644 (file)
--- a/docs/before_begin.rst
+++ b/docs/before_begin.rst
@@ -8,12 +8,15 @@ Before you begin you need some preparations.
 .. contents::
    :local:
 
+.. highlight:: none
 
 Software
 --------
 
-m_Librarian is written in Python and requires Python 2.7. So install
-Python 2.7 first. Install required modules: SQLObject and m_lib.
+m_Librarian is written in Python and requires Python (2.7 or 3.4+). So
+install Python first. Install required modules: SQLObject and
+m_lib.defenc. pip `installs <install.html>`_ required modules
+automatically.
 
 
 Library archives
@@ -23,6 +26,25 @@ The program works with local library archives so download some. In
 addition to the very libraries you need to get INPX indices for them —
 m_Librarian cannot index libraries yet.
 
+Configuration file
+------------------
+
+m_librarian looks up configuration file in $HOME/.config/ (if your OS is
+POSIX-compatible). The configuration file must be named
+``m_librarian.conf``. It must be in ``ini``-file format. The following
+sections and keys are now understood::
+
+    [database]
+    URI = "database URI"
+
+    [library]
+    path = "path to the library archives"
+
+    [download]
+    format = "download file format"
+
+Most programs have an option `-C|--config file` to use a non-default
+configuration file.
 
 Database
 --------
@@ -36,10 +58,7 @@ way of using m_Librarian.
 Database URI
 ^^^^^^^^^^^^
 
-For m_Librarian to use an SQL server create a configuration file and put
-it in $HOME/.config/ (if your OS is POSIX-compatible). Name the
-configuration file ``m_librarian.conf``. It must be in ``ini``-file
-format and must have the only section ``[database]`` with the only key
+In configuration file define section ``[database]`` with the only key
 ``URI``. The value for the key must be a Database URI in format accepted
 by SQLObject. Some examples::
 
@@ -52,7 +71,7 @@ by SQLObject. Some examples::
    [database]
    URI = sqlite:///full/path/to/database
 
-See some more examples in sample/m_librarian.conf. See detailed
+See some more examples in m_librarian.conf.sample. See detailed
 description for DB URIs in `SQLObject documentation
 <http://sqlobject.org/SQLObject.html#declaring-a-connection>`_.