Add before_begin.rst

diff --git a/docs-ru/before_begin.rst b/docs-ru/before_begin.rst
new file mode 100644 (file)
index 0000000..e23543a
--- /dev/null
+++ b/docs-ru/before_begin.rst
@@ -0,0 +1,56 @@
+
+Прежде чем вы начнёте
+=====================
+
+Прежде чем вы начнёте, вам потребуются некоторые приготовления.
+
+
+.. contents::
+   :local:
+
+
+Программное обеспечение
+-----------------------
+
+m_Librarian написан на языке Python, так что вам нужно скачать и
+установить Python 2.7. Нужны также библиотеки SQLObject и m_lib.
+
+
+Архивы библиотек
+----------------
+
+Данный программный комплекс работает с локальными файлами библиотек, так
+что предварительно скачайте некоторые библиотеки. Вот краткий и совсем
+не исчерпывающий список для скачивания:
+
+| http://torrent.rus.ec/index.php?c=3
+| http://booktracker.org/index.php?c=18
+| https://nnm-club.me/forum/viewtopic.php?t=353958
+| https://nnm-club.me/forum/viewtopic.php?t=510054
+| https://nnm-club.me/forum/viewtopic.php?t=521962
+| https://nnm-club.me/forum/viewtopic.php?t=877707
+
+Кроме самих библиотек вам понадобиться найти для них индексы INPX —
+m_Librarian пока не научился индексировать архивы библиотек.
+
+Индексы INPX обычно распространяются вместе с программами для работы с
+библиотеками, и такие программы есть в архивах по ссылкам выше.
+Некоторые индексы можно скачать с сайта одной из таких программ
+`MyHomeLib <http://home-lib.net/>`_:
+
+| http://home-lib.net/download/inpx/librusec_local_fb2.inpx
+| http://home-lib.net/download/inpx/librusec_local_usr.inpx
+| http://home-lib.net/download/inpx/librusec_local_all.inpx
+
+
+База данных
+-----------
+
+Для работы m_Librarian требуется база данных. m_Librarian может работать
+с любой БД, поддерживаемой библиотекой SQLObject. Предпочтительные
+варианты: MySQL, PostgreSQL или SQLite. При использовании сервера SQL БД
+вам придётся создать самим. Для SQLite файл БД будет создан программой,
+так что это наиболее простой способ использования m_Librarian,
+
+
+.. vim: set tw=72 :

diff --git a/docs-ru/index.rst b/docs-ru/index.rst
index c260f155552b5f3b0f392edbd0de264dc994b568..1e0d038c80ae9492ba2ae93460bd43e580223bc0 100644 (file)
--- a/docs-ru/index.rst
+++ b/docs-ru/index.rst
@@ -6,16 +6,18 @@
 Документация по m_Librarian
 ===========================
 
+Здесь должен быть (и, надеюсь, будет) набор программ для индексации
+библиотек LibRusEc и Флибуста (точнее, zip-файлов из торрентов) и показа
+содержимого индексов в командной строке, в web-интерфейсе и в
+графическом интерфейсе.
+
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-
-Здесь должен быть (и, надеюсь, будет) набор программ для индексации
-библиотек LibRusEc и Флибуста (точнее, zip-файлов из торрентов) и показа
-содержимого индексов в командной строке, в web-интерфейсе и в
-графическом интерфейсе.
+   before_begin
 
 
 Indices and tables

diff --git a/docs/before_begin.rst b/docs/before_begin.rst
new file mode 100644 (file)
index 0000000..d7521e0
--- /dev/null
+++ b/docs/before_begin.rst
@@ -0,0 +1,37 @@
+
+Before you begin
+================
+
+Before you begin you need some preparations.
+
+
+.. contents::
+   :local:
+
+
+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.
+
+
+Library archives
+----------------
+
+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.
+
+
+Database
+--------
+
+The program needs a database. It can work with any database supported by
+SQLObject. Preferred ones are: MySQL, PostgreSQL or SQLite. If you plan
+to use an SQL server you must create a database yourself. For SQLite,
+the database file will be created by the program, so it's the simplest
+way of using m_Librarian.
+
+
+.. vim: set tw=72 :

diff --git a/docs/index.rst b/docs/index.rst
index 13ff9549f2cbc3cfe0bc752a847353979af0076a..ecf263375787481da60319402f9699f5ea6c36f9 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,15 +6,17 @@
 Welcome to m_Librarian's documentation!
 =======================================
 
+This hopefully will be a collection of programs to index LibRusEc and
+Flibusta libraries (zipfiles from torrents, actually) and show their
+contents with command-line, web interface and GUI.
+
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-
-This hopefully will be a collection of programs to index LibRusEc and
-Flibusta libraries (zipfiles from torrents, actually) and show their
-contents with command-line, web interface and GUI.
+   before_begin
 
 
 Indices and tables