Skip to content

Commit 2930d10

Browse files
committed
Update README.
1 parent 3048361 commit 2930d10

2 files changed

Lines changed: 16 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,35 @@ To enhance your ESPminer optimization workflow, consider integrating the Optuna
3939

4040
---
4141

42-
## ⚙️ Requirements
42+
## Install
4343

44+
Dependencies:
4445
- Python 3
4546
- A ESPminer running firmware with the `/api/system` endpoints
4647

47-
Install dependencies:
48+
Directly install from PyPI [`espminer-optim`](https://pypi.org/project/espminer-optim/) via pip:
4849
```bash
49-
pip install .
50+
pip install espminer-optim
51+
```
52+
53+
## ⚙️ Development
54+
55+
Clone the repository and install it in editable mode
56+
```bash
57+
pip install -e .
5058
```
5159

5260
---
5361

5462
## 🧪 Running the Optimizer
5563

64+
Run the executable after install:
5665
```bash
57-
python optimize.py
66+
espminer-optim
5867
```
5968

69+
or run directly via Python runtime `python optimize.py`.
70+
6071
You’ll be prompted for:
6172
- ESPminer IP address
6273
- Frequency & voltage range

‎uv.lock‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)