Skip to content

Commit 8e5cd6c

Browse files
committed
README.md: Reformatted to use one sentence per line style
https://github.com/cfengine/website/blob/master/README.md#sentences-and-wrapping Signed-off-by: Ole Herman Schumacher Elgesem <ole@northern.tech>
1 parent 41f8f9d commit 8e5cd6c

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@ This repository contains the necessary tools to build and test cfengine packages
22

33
## Hardware requirements
44

5-
By experimentation I have found that building hub packages, which includes php dependency requires more than 1.6G of RAM/swap. 2.6G worked for me, less might work as well.
5+
By experimentation I have found that building hub packages, which includes php dependency requires more than 1.6G of RAM/swap.
6+
2.6G worked for me, less might work as well.
67

78
## Example build of Community Agent
89

910
A minimal example would be to build packages for cfengine community agent.
1011
This should be done in an isolated environment such as a dedicated host, virtual machine or linux container.
1112

12-
Install necessary distribution packages. For example on debian/ubuntu:
13+
Install necessary distribution packages.
14+
For example on debian/ubuntu:
1315

1416
```
1517
apt update -y
@@ -52,9 +54,7 @@ ls -l cfengine-community/*.deb
5254

5355
## General Build Machine Prerequisites
5456

55-
Due to sheer diversity of the environments, build machine is expected to provide
56-
strict minimum amount of software (don't forget --no-install-recommends on
57-
dpkg-based systems):
57+
Due to sheer diversity of the environments, build machine is expected to provide strict minimum amount of software (don't forget `--no-install-recommends` on dpkg-based systems):
5858

5959
To access the build machine:
6060

@@ -98,8 +98,7 @@ To build libvirt:
9898

9999
- pkg-config (pkg-config, pkgconfig)
100100

101-
Anything else is either preprocessed on buildbot slave or built and installed
102-
during build.
101+
Anything else is either preprocessed on buildbot slave or built and installed during build.
103102

104103
## Documentation build pre-requisites
105104

@@ -110,17 +109,13 @@ during build.
110109

111110
## Non-requisites
112111

113-
Build machines should not contain the following items, which may interfere with
114-
build process:
112+
Build machines should not contain the following items, which may interfere with build process:
115113

116-
- CFEngine itself, either in source or binary form (build machines are
117-
short-living, so this is not a problem)
118-
- Development packages for anything beside libc to avoid picking them up
119-
instead of bundled ones accidentally.
114+
- CFEngine itself, either in source or binary form (build machines are short-living, so this is not a problem)
115+
- Development packages for anything beside libc to avoid picking them up instead of bundled ones accidentally.
120116
- MySQL and PostgreSQL servers, clients and libraries
121117

122-
The following packages should not be installed on build machines as well, to
123-
avoid accidentally regenerating files transferred from buildslave:
118+
The following packages should not be installed on build machines as well, to avoid accidentally regenerating files transferred from buildslave:
124119

125120
- automake
126121
- autoconf

0 commit comments

Comments
 (0)