1[![Gitter chat](https://badges.gitter.im/cfengine/core.png)](https://gitter.im/cfengine/core)
2
3| Version    | [Core](https://github.com/cfengine/core)                                                                           | [MPF](https://github.com/cfengine/masterfiles)                                                                                  |
4|------------|--------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------|
5| master     | [![Core Build Status](https://travis-ci.org/cfengine/core.svg?branch=master)](https://travis-ci.org/cfengine/core) | [![MPF Build Status](https://travis-ci.org/cfengine/masterfiles.svg?branch=master)](https://travis-ci.org/cfengine/masterfiles) |
6| 3.15.x LTS | [![Core Build Status](https://travis-ci.org/cfengine/core.svg?branch=3.15.x)](https://travis-ci.org/cfengine/core) | [![MPF Build Status](https://travis-ci.org/cfengine/masterfiles.svg?branch=3.15.x)](https://travis-ci.org/cfengine/masterfiles) |
7| 3.12.x LTS | [![Core Build Status](https://travis-ci.org/cfengine/core.svg?branch=3.12.x)](https://travis-ci.org/cfengine/core) | [![MPF Build Status](https://travis-ci.org/cfengine/masterfiles.svg?branch=3.12.x)](https://travis-ci.org/cfengine/masterfiles) |
8
9[![codecov](https://codecov.io/gh/cfengine/core/branch/master/graph/badge.svg)](https://codecov.io/gh/cfengine/core)
10[![Language grade: C](https://img.shields.io/lgtm/grade/cpp/g/cfengine/core.svg?logo=lgtm&logoWidth=18&label=code%20quality)](https://lgtm.com/projects/g/cfengine/core/)
11
12# CFEngine 3
13
14CFEngine 3 is a popular open source configuration management system. Its primary
15function is to provide automated configuration and maintenance of large-scale
16computer systems.
17
18## Installation
19
20To install from source please see
21the [INSTALL](https://github.com/cfengine/core/blob/master/INSTALL) file for
22prerequisites and build instructions.
23
24## License
25
26As per the [LICENSE](https://github.com/cfengine/core/blob/master/LICENSE) file,
27CFEngine Community is licensed under the GNU General Public License, version 3.
28
29All the files in this repository are licensed under GNU GPL version 3, unless
30stated otherwise in the copyright notice inside the particular file.
31
32## Example Usage
33
34### Hello World
35
36The following code demonstrates simple CFEngine output through a reports promise.
37
38    body common control
39    {
40      bundlesequence => { "run" };
41    }
42
43    bundle agent run
44    {
45      reports:
46        cfengine::
47          "Hello, world";
48    }
49
50The following policy code may be executed with cf-agent (the main CFEngine binary) as follows.
51
52    $ cf-agent/cf-agent hello.cf
53    R: Hello, world
54
55## Contributing
56
57Please see the [CONTRIBUTING.md](https://github.com/cfengine/core/blob/master/CONTRIBUTING.md) file.
58
59## Relationship to CFEngine 2
60
61CFEngine 3 is *not* a drop-in upgrade for CFEngine 2 installations.  It is a
62significantly more powerful version, but it is incompatible with the CFEngine 2
63policy language.
64
65The server part of CFEngine 3 supports the network protocol of CFEngine 2, so you may
66upgrade your installation gradually.
67
68# Authors
69
70CFEngine was originally created by Mark Burgess with many contributions from
71around the world. Thanks [everyone](https://github.com/cfengine/core/blob/master/AUTHORS)!
72
73[CFEngine](https://cfengine.com) is sponsored by [Northern.tech AS](https://northern.tech)
74