From 55156aad26a890d8df4799c704e8c31fade2f6b0 Mon Sep 17 00:00:00 2001 From: Skot Date: Sat, 21 Sep 2024 01:13:27 -0400 Subject: [PATCH] Update readme.md --- readme.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 40d3562..1fa4eef 100755 --- a/readme.md +++ b/readme.md @@ -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`.