diff --git a/README b/README index d12fc36..f6b23a7 100644 --- a/README +++ b/README @@ -67,7 +67,7 @@ Specific Dependencies: * font: Ubuntu Mono (os font https://www.fontsquirrel.com/fonts/ubuntu-mono) ## Erase / Replace: Natasha -Description: Receives your scanned pages in order, then analyzes each image and its vocabulary. Finds and crops the least common words, and either erases them, or replaces them with the most common words. Outputs a PDF of increasingly distorted scan images. +Description: Receives your scanned pages in order, then analyzes each image and its vocabulary. Finds and crops the least common words, and either erases them, or replaces them with the most common words. Outputs a PDF of increasingly distorted scan images. for erase script run: `make erase` for replace script run: `make replace` @@ -78,11 +78,35 @@ Specific Dependencies: * select menu "Corpora" * select "stopwords" * "Download" -* Python Image Library (PIL): `pip3 install Pillow` +* Python Image Library (PIL): `pip3 install Pillow` * PDF generation for Python (FPDF): `pip3 install fpdf` * HTML5lib: `pip3 install html5lib` Notes & Bugs: -This script is very picky about the input images it can work with. For best results, please use high resolution images in RGB colorspace. Errors can occur when image modes do not match or tesseract cannot successfully make HOCR files. - +This script is very picky about the input images it can work with. For best results, please use high resolution images in RGB colorspace. Errors can occur when image modes do not match or tesseract cannot successfully make HOCR files. +## carlandre: Alice +Description: Generates concrete poetry from a text file. If you're connected to a printer located in /dev/usb/lp0 you can print the poem. + +run: make carlandre + +Dependencies: +* pytest (Documentation: https://docs.pytest.org/en/latest/getting-started.html) + +## over/under: Alice +Description: Interpreted programming language written in Python3 which translates basic weaving instructions into code and applies them to text. + +run: make overunder + +Instructions: +over/under works with specific commands which execute specific instructions. +When running, an interpreter will open: +> +To load your text, type 'load'. This is necessary before any other instructions. Every time you load the text, the previous instructions will be discarded. +To see the line you are currently on, type 'show'. +To start your pattern, type 'over' or 'under', each followed by an integer, separated by a comma. +e.g. over 5, under 5, over 6, under 10 +To move on to the next line of text, press enter twice. +To see your pattern, type 'pattern'. +To save your pattern in a text file, type 'save'. +To leave the program, type 'quit'.