diff --git a/README.md b/README.md index 8e4eb15..dc9cf2e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,23 @@ # overunder +Overunder is an interpreted programming language in Python that receives as rules basic weaving instructions 'over' and 'under' and apply a pattern onto text, simulating a plain weave. + +To start, add your text of choice in a file called `input.txt`. + +To run: + +``` +$ overunder +``` Commands: -- load - loads the input text -- show - shows which line you are currently working on -- over + int(x) - keeps the corresponding x characters intact -- under + int(x) - replaces the corresponding x characters with a symbol -- pattern - generates the pattern created so far -- save - saves the pattern in a text file -- enter/return - moves to the next line of text -- quit - quits the program +- `load` - loads the input text. Should be the first command you type inside the interpreter. +- `show` - shows which line you are currently working on +- `over + int(x)` - keeps the corresponding x characters intact +- `under + int(x)` - replaces the corresponding x characters with a symbol +- `pattern` - generates the pattern created so far +- `save` - saves the pattern in a text file +- `enter/return` - moves to the next line of text +- `quit` - quits the program See more [here](https://pzwiki.wdka.nl/mediadesign/User:Alice/Special_Issue_V). diff --git a/pyproject.toml b/pyproject.toml index 6745eff..f95fd1e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api" [tool.poetry] name = "overunder" -version = "1.0.2" +version = "1.0.3" description = "An interpreted programming language in Python that could receive as rules basic weaving instructions 'over' and 'under' and apply a pattern onto text." authors = ["anxiouspeanut "] maintainers = ["anxiouspeanut "]