aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 28120593f40c3aeec2882547b49d3038b3043ce2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Rainbow Parenthesis
===================

A simple script which highlights parenthesis on the data given on stdin.

    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.