Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Minor edits to formatting and phrasing.
  • Loading branch information
Zearin authored and kewisch committed Aug 17, 2022
1 parent 97266de commit c955384
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions tools/ICALTester/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ ICALTester

This is a simple program to compare various ICAL recurrence implementations
with ICAL.js. It generates random rules based on the format defined in
rules.json and runs them through the various libraries.
`rules.json` and runs them through the various libraries.

Running
-------
Expand All @@ -14,10 +14,12 @@ The usage goes as follows:
$ node compare.js rules.json ./support/libical-recur
```

The first argument to compare.js is the path to the rules.json described
further down. An example file is provided. The second argument is the path to a
binary executed for comparison. The binary should be able to take arguments as
in the following example and expects the same output:
* The first argument to `compare.js` is the path to the `rules.json` (described
further down). An example file is provided.
* The second argument is the path to a binary executed for comparison.

The binary should be able to take arguments as in the following example;
it expects the same output:

```bash
# Usage: ./support/libical-recur <rrule> <dtstart> <occurrence count>
Expand All @@ -34,13 +36,13 @@ $ ./support/libical-recur "FREQ=MONTHLY;BYDAY=1FR,3SU" "2014-11-11T08:00:00" 10
20150403T080000
```

The libical-recur binary can be built using the provided Makefile.
The **`libical-recur`** binary can be built using the provided `Makefile`.

rules.json
----------

The format is the same as what can be passed to ICAL.Recur.fromData(), with one
addition. If the value is `%`, the tester generates a random rule value.
The format is the same as what can be passed to `ICAL.Recur.fromData()`, with one
addition: If the value is `%`, the tester generates a random rule value.

Example:

Expand Down

0 comments on commit c955384

Please sign in to comment.