Browse Source

fixed readme

master
alicestrt 4 years ago
parent
commit
35257c9db6
  1. 25
      README.md
  2. 2
      pyproject.toml

25
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).

2
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 <alice.strt@gmail.com>"]
maintainers = ["anxiouspeanut <alice.strt@gmail.com>"]

Loading…
Cancel
Save