]> git.phdru.name Git - m_librarian.git/blob - docs/before_begin.rst
Add before_begin.rst
[m_librarian.git] / docs / before_begin.rst
1
2 Before you begin
3 ================
4
5 Before you begin you need some preparations.
6
7
8 .. contents::
9    :local:
10
11
12 Software
13 --------
14
15 m_Librarian is written in Python and requires Python 2.7. So install
16 Python 2.7 first. Install required modules: SQLObject and m_lib.
17
18
19 Library archives
20 ----------------
21
22 The program works with local library archives so download some. In
23 addition to the very libraries you need to get INPX indices for them —
24 m_Librarian cannot index libraries yet.
25
26
27 Database
28 --------
29
30 The program needs a database. It can work with any database supported by
31 SQLObject. Preferred ones are: MySQL, PostgreSQL or SQLite. If you plan
32 to use an SQL server you must create a database yourself. For SQLite,
33 the database file will be created by the program, so it's the simplest
34 way of using m_Librarian.
35
36
37 .. vim: set tw=72 :