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.com/cfengine/core.svg?branch=master)](https://app.travis-ci.com/github/cfengine/core) | [![MPF Build Status](https://travis-ci.com/cfengine/masterfiles.svg?branch=master)](https://app.travis-ci.com/github/cfengine/masterfiles) |
6| 3.18.x LTS | [![Core Build Status](https://travis-ci.com/cfengine/core.svg?branch=3.18.x)](https://app.travis-ci.com/github/cfengine/core) | [![MPF Build Status](https://travis-ci.com/cfengine/masterfiles.svg?branch=3.18.x)](https://app.travis-ci.com/github/cfengine/masterfiles) |
7| 3.15.x LTS | [![Core Build Status](https://travis-ci.com/cfengine/core.svg?branch=3.15.x)](https://app.travis-ci.com/github/cfengine/core) | [![MPF Build Status](https://travis-ci.com/cfengine/masterfiles.svg?branch=3.15.x)](https://app.travis-ci.com/github/cfengine/masterfiles) |
8| 3.12.x LTS | [![Core Build Status](https://travis-ci.com/cfengine/core.svg?branch=3.12.x)](https://app.travis-ci.com/github/cfengine/core) | [![MPF Build Status](https://travis-ci.com/cfengine/masterfiles.svg?branch=3.12.x)](https://app.travis-ci.com/github/cfengine/masterfiles) |
9
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## Source code repositories
19
20CFEngine is comprised of several source code repositories.
21As you might be looking for another part of the open source code base, here is a list to ease navigation:
22
23* [core](https://github.com/cfengine/core) (This repo) - The C source code for core components, like cf-agent and cf-serverd.
24  * [libntech](https://github.com/cfengine/libntech) (submodule in core) - Library of reusable C code, such as data structures, string manipulation, JSON parsing, file handling, etc.
25  * [core/contrib](https://github.com/cfengine/core/tree/master/contrib) (subdirectory in core) - User-contributed tools and scripts
26* [masterfiles](https://github.com/cfengine/masterfiles) - The Masterfiles Policy Framework (MPF) contains the default policy (.cf) files
27* [documentation](https://github.com/cfengine/documentation) - Documentation on how CFEngine components work, the policy language, the enterprise features, etc.
28* [cf-remote](https://github.com/cfengine/cf-remote) - Tooling to make deploying / testing CFEngine across many remote instances easy
29* [buildscripts](https://github.com/cfengine/buildscripts) - Scripts and files needed to build installer packages across a wide variety of supported platforms
30
31(Each repo also contains some supporting code/files, such as tests, scripts, documentation, etc.).
32
33## Installation
34
35Pre-built installers are available from our website:
36
37* [Download CFEngine Enterprise Installers](https://cfengine.com/product/cfengine-enterprise-free-25/)
38* [Download CFEngine Community Installers](https://cfengine.com/product/community/)
39
40To install from source please see
41the [INSTALL](https://github.com/cfengine/core/blob/master/INSTALL) file for
42prerequisites and build instructions.
43
44## License
45
46As per the [LICENSE](https://github.com/cfengine/core/blob/master/LICENSE) file,
47CFEngine Community is licensed under the GNU General Public License, version 3.
48
49All the files in this repository are licensed under GNU GPL version 3, unless
50stated otherwise in the copyright notice inside the particular file.
51
52## Example Usage
53
54### Hello World
55
56The following code demonstrates simple CFEngine output through a reports promise.
57
58    body common control
59    {
60      bundlesequence => { "run" };
61    }
62
63    bundle agent run
64    {
65      reports:
66        cfengine::
67          "Hello, world";
68    }
69
70The following policy code may be executed with cf-agent (the main CFEngine binary) as follows.
71
72    $ cf-agent/cf-agent hello.cf
73    R: Hello, world
74
75## Contributing
76
77Please see the [CONTRIBUTING.md](https://github.com/cfengine/core/blob/master/CONTRIBUTING.md) file.
78
79## Relationship to CFEngine 2
80
81CFEngine 3 is *not* a drop-in upgrade for CFEngine 2 installations.  It is a
82significantly more powerful version, but it is incompatible with the CFEngine 2
83policy language.
84
85The server part of CFEngine 3 supports the network protocol of CFEngine 2, so you may
86upgrade your installation gradually.
87
88# Authors
89
90CFEngine was originally created by Mark Burgess with many contributions from
91around the world. Thanks [everyone](https://github.com/cfengine/core/blob/master/AUTHORS)!
92
93[CFEngine](https://cfengine.com) is sponsored by [Northern.tech AS](https://northern.tech)
94