Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeWnuk committed Dec 2, 2024
1 parent 2218535 commit 9a75e14
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -506,12 +506,12 @@ This mode allows applying rules to the input. The syntax is as follows:
```
ptt -f <input_file> -t rule-apply -tf <rule_file>
```
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 <input_file> -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.
```
2 changes: 1 addition & 1 deletion main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9a75e14

Please sign in to comment.