Skip to content

Commit 41f8f9d

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

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

scripts/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# deptool
22

3-
`deptool.py` is a script which can be used to enumerate dependencies of CFEngine. It supports printing to stdout in the Markdown table format, and printing to file in the JSON format (see `--to-json`). It can be used as a replacement for the [cf-bottom](https://github.com/cfengine/cf-bottom/) `depstable` command.
3+
`deptool.py` is a script which can be used to enumerate dependencies of CFEngine.
4+
It supports printing to stdout in the Markdown table format, and printing to file in the JSON format (see `--to-json`).
5+
It can be used as a replacement for the [cf-bottom](https://github.com/cfengine/cf-bottom/) `depstable` command.
46

5-
`deptool.py` works on a local buildscripts repository. By default, the repository is assumed to be current working directory (i.e. `.`). A custom path for the local repository can be specified using the `--root` argument. Running the script will modify the git state of the repository by checking out branches (and with `--patch`, also overwriting and git-adding `README.md`), so it might be preferable to [use a copy of the buildscripts repository](https://github.com/cfengine/buildscripts/tree/master/scripts#using-a-copy-of-the-repository).
7+
`deptool.py` works on a local buildscripts repository. By default, the repository is assumed to be current working directory (i.e. `.`).
8+
A custom path for the local repository can be specified using the `--root` argument.
9+
Running the script will modify the git state of the repository by checking out branches (and with `--patch`, also overwriting and git-adding `README.md`), so it might be preferable to [use a copy of the buildscripts repository](https://github.com/cfengine/buildscripts/tree/master/scripts#using-a-copy-of-the-repository).
610

711
A custom list of versions to process can be specified ([given as space-separated command-line arguments](https://github.com/cfengine/buildscripts/tree/master/scripts#specifying-custom-versions-list)).
812

0 commit comments

Comments
 (0)