Add before_begin.rst

[m_librarian.git] / docs / before_begin.rst

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 :