From 9a75e146ee0c6543f36ea80f05b1ba5d13e60527 Mon Sep 17 00:00:00 2001 From: Jake Wnuk Date: Mon, 2 Dec 2024 18:55:34 -0500 Subject: [PATCH] docs --- README.md | 2 +- docs/USAGE.md | 4 ++-- main.go | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f233e24..a4c1601 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ These create or alter based on the selected mode. -t rule-prepend-toggle Transforms input by creating prepend-toggle rules. -t rule-simplify - Transforms input by simplifying rules to efficient equivalents. + Transforms input by simplifying rules to efficient equivalents using the HCRE library. -t rule-toggle -i [index] Transforms input by creating toggle rules starting at index. -t substring -i [index] diff --git a/docs/USAGE.md b/docs/USAGE.md index 7e7850f..bf33556 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -506,12 +506,12 @@ This mode allows applying rules to the input. The syntax is as follows: ``` ptt -f -t rule-apply -tf ``` -The `rule-apply` transformation will apply rules from the rule file to the input. The rule file should contain the rules to be applied to the input. The output will be the input with the rules applied. This feature is enabled by the work done on the [HCRE](https://git.launchpad.net/hcre/tree/README.md) project. Please consider visiting the project for more information and supporting the author. +The `rule-apply` transformation will apply rules from the rule file to the input. The rule file should contain the rules to be applied to the input. The output will be the input with the rules applied. This feature is enabled by the work done on the [HCRE](https://git.launchpad.net/hcre/tree/README.md) project. Please consider visiting and supporting the project. ### Rule Simplification This mode allows simplifying rules from the input. The syntax is as follows: ``` ptt -f -t rule-simplify ``` -The `rule-simplify` transformation will simplify rules from the input. The output will be the simplified rules equivalent to the input. This feature is enabled by the work done on the [HCRE](https://git.launchpad.net/hcre/tree/README.md) project. Please consider visiting the project for more information and supporting the author. +The `rule-simplify` transformation will simplify rules from the input. The output will be the simplified rules equivalent to the input. This feature is enabled by the work done on the [HCRE](https://git.launchpad.net/hcre/tree/README.md) project. Please consider visiting and supporting the project. ``` diff --git a/main.go b/main.go index 8757f4b..0fb0e49 100644 --- a/main.go +++ b/main.go @@ -68,7 +68,7 @@ func main() { "replace-all -tf [file]": "Transforms input by replacing all strings with all matches from a ':' separated file.", "regram -w [words]": "Transforms input by 'regramming' sentences into new n-grams with a given number of words.", "rule-apply -tf [file]": "Transforms input by applying rules to strings using the HCRE library.", - "rule-simplify": "Transforms input by simplifying rules to efficient equivalents.", + "rule-simplify": "Transforms input by simplifying rules to efficient equivalents using the HCRE library.", } // Sort and print transformation modes