add first version of a README
[zonemaker.git] / README.rst
1 zonemaker: Write your DNS zone files in Python
2 ==============================================
3
4 Introduction
5 ------------
6
7 This is zonemaker_, a tool to generate DNS zone files from Python.
8
9 The plain zone file format is pretty limited. There are not even variables, so in many cases IP addresses and other data has to be repeated several times.
10 zonemaker is an attempt to provide more flexibility, by allowing you to write your zones in Python.
11 Hence all the usuel fatures, like variables, macros (aka functions) and loops, are available to generate DNS zone data.
12 At the same time, zonemaker is reasonably simple and close to the actual structure of a DNS zonefile, so it is suited for small setups.
13 The output of zonemaker is a standard zonefile, so it can be used with any DNS server supporting those.
14
15 .. _dyn-nsupdate: https://www.ralfj.de/projects/zonemaker
16
17 Usage
18 -----
19
20 TODO
21
22 Source, License
23 ---------------
24
25 You can find the sources in the `git repository`_. They are provided under a 
26 2-clause BSD license.
27
28 .. _git repository: http://www.ralfj.de/git/zonemaker.git
29
30 Contact
31 -------
32
33 If you found a bug, or want to leave a comment, please
34 `send me a mail <mailto:post-AT-ralfj-DOT-de>`_.