From 836aebf5879c9f25e07ec7d6a219fdc961d4c82a Mon Sep 17 00:00:00 2001
From: Luca <luca.erbetta105@gmail.com>
Date: Tue, 11 May 2021 14:46:56 +0200
Subject: [PATCH] Update README.md

---
 README.md | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 32bc142..9a87e8d 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
 [![PyPi](https://img.shields.io/pypi/v/cutelog.svg?style=flat-square)](https://pypi.python.org/pypi/cutelog)
 
 This is a graphical log viewer for Python's logging module.
-- 
GitLab