Skip to content

Commit

Permalink
Merge pull request #46 from hapytex/feature/doc-executable
Browse files Browse the repository at this point in the history
document executable
  • Loading branch information
KommuSoft committed Jan 28, 2024
2 parents 9259e84 + bf84aa7 commit 51b9fad
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,24 @@ twaalf minuten na half zeven 's avonds
One can also define a language algorithm themselves, for this one can look at
the source code of the language modules.

## Executable

The package also includes an executable named `ordinal`. One can use `ordinal` with:

```
ordinal [OPTIONS..] [numbers..]
```

where `OPTIONS` specifies the language and the format that should be used to convert the numbers, and the numbers can be specified as an integer, or with `hh:mm` notation.

The options are:

- **`-l=en`**/**`-lang=en`**/**`--language=en`**: is used to specify the language as an ISO-639 code, or the full name of the language. By default English (`en`);
- **`-c`**/**`--cardinal`** set the number mode to cardinal, which is the default mode;
- **`-o`**/**`--ordinal`** set the number mode to ordinal;
- **`-s`**/**`--short-ordinal`** set the number mode to short ordinal; and
- **`-t`**/**`--time`** set the number mode to time.

## Package structure

The modules are all located under `Text.Numerals` module. The `Text.Numerals`
Expand Down

0 comments on commit 51b9fad

Please sign in to comment.