diff options
-rw-r--r-- | README.md | 24 |
1 files changed, 23 insertions, 1 deletions
@@ -3,4 +3,26 @@ Rainbow Parenthesis A simple script which highlights parenthesis on the data given on stdin. - cat main.py | ./main.py + cat main.py | python -m rainbow_parenthesis + +Building +-------- + +To build and package a wheel (and then install it): + + # Creates dist/rainbow_parenthesis-0.1-py3-none-any.whl + make build + # Installs the wheel file to the destination + make install DESTDIR=$PWD/destdir + +Running linters: + + make check + + +Generating documentation. This creates `doc.rendered/index.html` (among other files): + + make documentation + + +See makefile for further details. |