Skip to content

chore: improve readme #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
saerdnaer wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: improve readme #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 24 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down