Skip to content

Commit

Permalink
✨ Improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mawoka-myblock committed Jul 16, 2024
1 parent aa00d3a commit 0ebb2db
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/platformio_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ jobs:
- name: Build PlatformIO Project
run: pio run
- name: Combine into single file
run: esptool.py --chip esp32c3 merge_bin -o fw.bin --flash_size 4MB 0x1000 .pio/build/mini_c3/bootloader.bin 0x8000 .pio/build/mini_c3/partitions.bin 0x10000 .pio/build/mini_c3/firmware.bin
run: esptool.py --chip esp32c3 merge_bin -o td-free.bin --flash_size 4MB 0x1000 .pio/build/mini_c3/bootloader.bin 0x8000 .pio/build/mini_c3/partitions.bin 0x10000 .pio/build/mini_c3/firmware.bin
- name: Upload esp32c3
uses: actions/upload-artifact@v4
with:
path: ./fw.bin
path: ./td-free.bin
name: esp32c3-4mb
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The CAD is available in the [onshape workspace](https://cad.onshape.com/document
| only for checking samples | **monitor td of spool as it's printing** |

So, in summary, the Td-Free is **cheaper**, **open-source**[^1], **smaller** and **wifi-enabled**.
But if you want a full featured one and have enough money to spend, feel free to buy the parts list and a license.
But if you want a full featured one and have enough money to spend, feel free to buy the parts list and a license for a td-1.

## Requirements

Expand Down Expand Up @@ -75,8 +75,8 @@ At first, I'd recommend soldering all the components together.
1. Download the latest build [here](https://nightly.link/mawoka-myblock/td-free/workflows/platformio_build/main/esp32c3-4mb.zip).
They are directly built by GitHub.
2. Extract the downloaded zip file.
3. Install esp-tool.
4. Flash the esp32: `esptool.py -b 230400 write_flash 0x0 firmware.bin`
3. [Install esp-tool](https://docs.espressif.com/projects/esptool/en/latest/esp32/#quick-start).
4. Flash the esp32: `esptool.py -b 230400 write_flash 0x0 td-free.bin`

## Usage

Expand Down

0 comments on commit 0ebb2db

Please sign in to comment.