diff --git a/README.md b/README.md index 32bc142a9dcecc96ece2a47a1ea99dc6f5979af1..9a87e8dcb18844a0533cecd6a734961ff6bbb5e7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,28 @@ -# cutelog – GUI for logging +# Cutelog Serial +Open serial port & display log messages in a GUI, with the ability to fitler them by name, log level or custom filters. +Forked from https://github.com/busimus/cutelog + +## Installing +1. Install requirements: + `pip3 install -r requirements.txt` +2. Build + `python3 setup.py build` +3. Install + `python3 setup.py install` + +## Running +`cutelog PORT BAUD` +### Examples +`cutelog \dev\ttyUSB0 115200` +`cutelog COM6 19200` + +## TODO +- Add gui window/menu to open a serial port +- Add ability to open multiple ports +- Add ability to disconnect/reconnect to a previously open port + + +# [Original README.md] cutelog – GUI for logging [](https://pypi.python.org/pypi/cutelog) This is a graphical log viewer for Python's logging module.