diff options
author | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-08-20 12:53:51 +0200 |
---|---|---|
committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2023-08-20 12:53:51 +0200 |
commit | df7317fa09a2a32a0865378f236f46b9b5e59eb5 (patch) | |
tree | 64ea4fa4ea82af7dcb9d91547f1a6d3871f368a6 | |
parent | Made project packable. (diff) | |
download | rainbow-parenthesis-df7317fa09a2a32a0865378f236f46b9b5e59eb5.tar.gz rainbow-parenthesis-df7317fa09a2a32a0865378f236f46b9b5e59eb5.tar.xz |
Update readme.v0.1
-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. |