Skip to content

Commit e6dbf1a

Browse files
Felix WidmaierZandru
authored andcommitted
Add readme
1 parent 1e6ad06 commit e6dbf1a

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Python Color Printer
2+
====================
3+
4+
This package provides a class to print colored output on the terminal.
5+
6+
Author: Felix Widmaier
7+
8+
9+
Installation
10+
------------
11+
12+
To install the package use the `setup.py`:
13+
14+
python setup.py install
15+
16+
17+
Usage
18+
-----
19+
20+
This is a simple example how to use the color printer:
21+
22+
from colorprinter import cprint
23+
cprint.red().echo("This text is red")
24+
cprint.blue().bold().echo("This text is blue and bold")
25+
26+
For more details type
27+
28+
import colorprinter
29+
help(colorprinter.ColorPrinter)

0 commit comments

Comments
 (0)