README.md 2.07 KB
Newer Older
mats Dufberg's avatar
mats Dufberg committed
1
# Zonemaster Engine
Patrik Wallström's avatar
Patrik Wallström committed
2

mats Dufberg's avatar
mats Dufberg committed
3
## Purpose
Patrik Wallström's avatar
Patrik Wallström committed
4

mats Dufberg's avatar
mats Dufberg committed
5
This repository holds one of the components of the Zonemaster product. For an
6
overview of the Zonemaster software, please see the
7
[Zonemaster main repository].
8
9

This Git repository contains the *Zonemaster Engine testing framework*,
Patrik Wallström's avatar
Patrik Wallström committed
10
11
12
and contains all code needed to perform the full suite of Zonemaster
tests.

mats Dufberg's avatar
mats Dufberg committed
13
## Prerequisites
Patrik Wallström's avatar
Patrik Wallström committed
14

15
16
For supported processor architectures, operating systems and Perl versions see
[Zonemaster/README.md].
mats Dufberg's avatar
mats Dufberg committed
17

mats Dufberg's avatar
mats Dufberg committed
18
## Installation
Patrik Wallström's avatar
Patrik Wallström committed
19
20

Installation instructions for the Engine is provided in the
21
[installation] document.
Patrik Wallström's avatar
Patrik Wallström committed
22

23
## Configuration
Patrik Wallström's avatar
Patrik Wallström committed
24

25
26
This repository does not need any specific configuration.

27
28
29
30
31
32
33
34
35
## Docker

Zonemaster-CLI is available on [Docker Hub], and can be conveniently downloaded
and run without any installation. See [USING] Zonemaster-CLI for how to run
Zonemaster-CLI on Docker.

To build your own Docker image, see the [Docker Image Creation] documentation.


mats Dufberg's avatar
mats Dufberg committed
36
## Documentation
Patrik Wallström's avatar
Patrik Wallström committed
37
38

There is full POD coverage of the Perl code. The documentation can be
39
40
41
read on the [CPAN site].

Documentation on Zonemaster-Engine is also found under the [docs] directory.
Patrik Wallström's avatar
Patrik Wallström committed
42

43

mats Dufberg's avatar
mats Dufberg committed
44
## Participation, Contact and Bug reporting
45

46
For participation, contact and bug reporting, please see
47
[Zonemaster/README.md](https://github.com/zonemaster/zonemaster/blob/master/README.md).
48
49


50
51
52
53
54
55
56
57
[CPAN site]:                                      https://metacpan.org/pod/Zonemaster::Engine
[Docker Hub]:                                     https://hub.docker.com/u/zonemaster
[Docker Image Creation]:                          https://github.com/zonemaster/zonemaster/blob/master/docs/internal-documentation/maintenance/ReleaseProcess-create-docker-image.md
[Docs]:                                           docs/
[Installation]:                                   docs/Installation.md
[USING]:                                          https://github.com/zonemaster/zonemaster-cli/blob/master/USING.md
[Zonemaster main repository]:                     https://github.com/zonemaster/zonemaster
[Zonemaster/README.md]:                           https://github.com/zonemaster/zonemaster/blob/master/README.md
58

Patrik Wallström's avatar
Patrik Wallström committed
59
60