From d199e403484a6e763bd913a622a0c003c5e090e1 Mon Sep 17 00:00:00 2001 From: Andreas Hubel Date: Fri, 24 Nov 2023 18:56:18 +0100 Subject: [PATCH] chore: improve readme --- README.md | 31 ++++++++++++++++++++++++------- 1 file changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7a1860d..29cd516 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,45 @@ Be a patron at [Patreon](https://www.patreon.com/enesbcs) # espfinder-python -Find ESP8266 modules in the /24 network neighborhood, and collect infos about them. (ESPEasy,Tasmota,ESPurna,Tuya,Shelly,RPIEasy) +Find ESP8266 modules in the /24 network neighborhood, and collect infos about them. (ESPEasy, Tasmota, ESPurna, Tuya,Shelly, RPIEasy) + +## Installation Requirements: - Linux - Python3 Install prerequisite libraries (Debian/Ubuntu): - sudo apt-get install python3-tk +```sh +sudo apt-get install python3-tk +``` (*)Debian Stretch specific prerequisite: (ifconfig required) - sudo apt-get install net-tools +```sh +sudo apt-get install net-tools +``` Install prerequisite libraries (Arch): - sudo pacman -S tk +```sh +sudo pacman -S tk +``` + + + +## Usage Run GUI: - python3 espfinder.py +```sh +python3 espfinder.py +``` Run plain console: - python3 espfinder.py -t +```sh +python3 espfinder.py -t +``` + -Update: +## Release notes 0.5 - (enesbcs) added RPIEasy detection support