diff options
| author | ayyansea <ayyansea@gmail.com> | 2024-11-21 23:19:33 +0300 |
|---|---|---|
| committer | ayyansea <ayyansea@gmail.com> | 2024-11-21 23:19:33 +0300 |
| commit | 995ca4fd7aeeedfe65c4294009245a9e0b04d616 (patch) | |
| tree | dae2be2c99fd1172b3e8ea254e34455dabbc61a1 | |
| parent | 7f9ea2a5c01076017b01164a885be46215f33546 (diff) | |
chore: define end goals
| -rw-r--r-- | README.md | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -1 +1,19 @@ # Undeclared Purpose Text Filtering System (uptfs) + +This program takes some text, slices it to a number of tokens and applies filters to them. + +uptfs will be considered complete as soon as all these statements are true: + +* it can read text either from stdin or from a plain text file +* it can output text either to stdout or to a file +* it can be configured either fully with command line options or with a YAML file (or with a mix of both) +* it has the following configuration options (both in CLI and file modes): + * -c, --config-file - path to the config file + * -i, --input-file - path to the input file + * -o, --output-file - path to the output file + * -f, --filter - name of a filter to apply (can be used multiple times) +* it prioritizes command line options over those in the config file +* it contains at least 7 different predefined filters +* it has 'normal' and 'verbose' modes, the latter meaning presence of debug logs while the program is running + +Doing more doesn't really make sense since this is a learning project.
\ No newline at end of file |