Update readme.md

This commit is contained in:
Skot 2024-09-21 01:13:27 -04:00 committed by GitHub
parent 605221c875
commit 55156aad26
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -8,7 +8,7 @@
# ESP-Miner
esp-miner is open source ESP32 firmware for the [Bitaxe](https://github.com/skot/bitaxe)
If you are looking for binaries images to load on your Bitaxe, check out the [releases](https://github.com/skot/ESP-Miner/releases) page. Maybe you want [instructions](https://github.com/skot/ESP-Miner/blob/master/flashing.md) for loading factory images.
If you are looking for premade images to load on your Bitaxe, check out the [releases](https://github.com/skot/ESP-Miner/releases) page. Maybe you want [instructions](https://github.com/skot/ESP-Miner/blob/master/flashing.md) for loading factory images.
# Bitaxetool
We also have a command line python tool for flashing Bitaxe and updating the config called Bitaxetool
@ -22,7 +22,7 @@ pip install --upgrade bitaxetool
```
The bitaxetool includes all necessary library for flashing the binary file to the Bitaxe Hardware.
The bitaxetool requires a config.cvs preloaded file and the appropiate firmware.bin file in it's executed directory.
You need to provide a config.cvs file (see repo for examples) and the appropiate firmware.bin file in it's executed directory.
- Flash with the bitaxetool
@ -31,7 +31,7 @@ bitaxetool --config ./config.cvs --firmware ./esp-miner-factory-v2.0.3.bin
```
## AxeOS API
Bitaxe provides an API to expose actions and information.
The esp-miner UI is called AxeOS and provides an API to expose actions and information.
For more details take a look at `main/http_server/http_server.c`.