Documentation

[jmeaster30]

I would like to write up some better documentation to explain what each operator does better than just saying what regex operator it corresponds to.

Things I want documented:

• [ ] Install CLI and install lib
• [ ] lexer rules
• [ ] parsing rules
• [ ] typechecking rules
• [ ] find
  • [ ] amounts
• [ ] set
  • [ ] pattern
  • [ ] transform
  • [ ] matches (I actually haven't used this at all yet. Not sure if it will live long)
• [ ] replace with
  • [ ] replace modes
  • [ ] amounts (note that it is the same as find)
  • [ ] how the replacement function works
• [ ] loops
  • [ ] at least
  • [ ] at most
  • [ ] between
• [ ] in
• [ ] not in
• [ ] character classes
  • [ ] digit
  • [ ] letter
  • [ ] whitespace
  • [ ] any
  • [ ] upper
  • [ ] lower
  • [ ] not
  • [ ] whole line
  • [ ] whole word
  • [ ] whole file
• [ ] anchors
  • [ ] line (start/end)
  • [ ] word (start/end)
  • [ ] file (start/end)
• [ ] processes/predicates
  • [ ] syntax
  • [ ] commands
  • [ ] return type rules

[jmeaster30]

I've started working on some regular expression examples from the one site I've been using as my resource. Working through examples has given me some vision in what is needed for full proper documentation

[jmeaster30]

Added a Getting Started / Hello World / CLI Documentation with examples

[jmeaster30]

Tracking in docs/TODO.md