fix typos, add license info
[bdrem.git] / README.rst
1 *********************************
2 bdrem - Birthday reminder by mail
3 *********************************
4 Birthday reminder that sends out mails (Text and HTML).
5
6 It can also generate tables on your console/shell output and
7 normal HTML pages.
8
9
10
11 =============
12 Configuration
13 =============
14 Copy ``data/bdrem.config.php.dist`` to ``data/bdrem.config.php`` and
15 adjust it to your liking.
16
17
18 MS SQL server
19 =============
20 Configure the date format in ``/etc/freetds/locales.conf``::
21
22     [default]
23         date format = %Y-%m-%d
24
25 Also set the charset to UTF-8 in ``/etc/freetds/freetds.conf``::
26
27     [global]
28         # TDS protocol version
29         tds version = 8.0
30         client charset = UTF-8
31
32 Restart Apache afterwards.
33
34 Use ``dblib`` in the DSN::
35
36     dblib:host=192.168.1.1;dbname=Databasename
37
38
39 =======
40 License
41 =======
42 ``bdrem`` is licensed under the `AGPL v3`__ or later.
43
44 __ http://www.gnu.org/licenses/agpl.html
45
46
47 ======
48 Author
49 ======
50 Written by Christian Weiske, cweiske@cweiske.de