diff --git a/README.md b/README.md index c7dcbf1..ea2c8c1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ -### TRMNL FLASH LOGO +### Tailor your TRMNL -This repository lets you upload custom brand information onto your TRMNL. Supported Brand attributes are -1. Logo -2. Loading Icon +This repository contains the source code that lets you tailor your TRMNL. This works by creating a brand binary on your browser and updating the brand binary on the device directly without downloading / installing / modifying the [firmware](https://github.com/usetrmnl/trmnl-firmware) source code. + +## Supported Changes +You can make customizations to the following brand attributes +1. API Base URL (coming soon) +2. Logo +3. Loading Icon ### How to get started? 1. Clone this repository 2. `git submodule init` 3. `git submodule update` 4. Install emscripten eg: `brew install emscripten` -4. Compile the binary to wasm file `bash build.sh` +5. Compile and create a wasm file `bash build.sh` +6. open `index.html` on your browser. diff --git a/index.html b/index.html index f5f941d..1198cd2 100644 --- a/index.html +++ b/index.html @@ -74,7 +74,7 @@ .card h2 { font-size: 20px; font-weight: 600; - margin-bottom: 24px; + margin-bottom: 20px; } .upload-zone { @@ -215,8 +215,7 @@ } .instructions { - margin-top: 32px; - padding: 24px; + padding: 20px; background: #fafafa; border-radius: 8px; } @@ -236,7 +235,7 @@ } .instructions li { - margin-bottom: 8px; + margin-bottom: 5px; } footer { @@ -410,15 +409,15 @@ btn.textContent = 'Ready to Flash!'; setTimeout(() => { - btn.textContent = 'Generate Firmware'; - btn.disabled = false; + btn.textContent = ''; + btn.disabled = true; }, 2000); } catch (error) { console.error(error); btn.textContent = 'Error - Try Again'; setTimeout(() => { - btn.textContent = 'Generate Firmware'; - btn.disabled = false; + btn.textContent = 'Generate Binary'; + btn.disabled = true; }, 2000); } }; @@ -430,13 +429,13 @@
- +

Tailor your TRMNL

+

Upload custom logo and loader images to your TRMNL. Maximum 800×480 pixels.

@@ -471,7 +470,7 @@
-

Flash Firmware

+

Upload Firmware

@@ -487,25 +486,35 @@
- Connect and upload custom Logo +
- +
+
+

Instructions

-

Instructions

  1. Upload logo and loader images (max 800×480 pixels)
    2. -
  2. Click "Generate Binary"
    3. -
  3. Connect TRMNL via USB
    4. -
  4. Click "Connect" and select device
    5. -
  5. Upload the Logo Binary to TRMNL.
    6. -
+
  • Click 'Generate Binary'
    • +
  • Plug in your device via USB
    • +
  • Enter Flashing mode
    • +
      1. Turn off the device by flipping the power switch to 'OFF'
    +
      2. While pressing down on the circular button, flip the power switch to 'ON'
    +
      3. Let go of the circular button
    +
  • Upload Brand Binary to device
    • +
      1. Click the 'Connect' button below
    +
      2. Select 'USB JTAG/serial...' from the list
    +
      3. Select 'Install' from the popup menu and confirm
    +
      4. Wait for the device to write brand binary (this may take upto a minute)
    +
      5. You should see a confirmation message within the popup menu
    +
  • Step 5 - Restart your device
    • +
      1. Turn the device off by flipping the power switch to 'OFF'
    +
      2. Wait approximately 15 seconds
    +
      3. Flip the power switch to 'ON'
    -
    - TRMNL Custom Logo Uploader -
    +
    \ No newline at end of file