Skip to content

Commit 5d722ef

Browse files
Update README.md
1 parent 455d521 commit 5d722ef

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,26 +54,33 @@ Features include
5454

5555
>This [repository](https://tcd.out-a-ti.me) is the upstream source for CircuitSetup's releases. The differences are that both code and documentation [here](https://tcd.out-a-ti.me) might be ahead in development, and in the sound-packs.
5656
57-
## Firmware Installation
57+
## TL;DR
58+
59+
Plug it in, use it like in the movies.
60+
61+
## Firmware Installation / Firmware Update
5862

5963
If a previous version of the TCD firmware is installed on your device, you can update easily using the pre-compiled binary. Enter the [Config Portal](#the-config-portal), click on "Update" and select the pre-compiled binary file ("xxx.bin") provided in the Release package.
6064

65+
<details>
66+
<summary>If you are using a fresh ESP32 board...</summary>
6167
If you are using a fresh ESP32 board, please see [timecircuits-A10001986.ino](https://github.com/realA10001986/Time-Circuits-Display/blob/main/timecircuits-A10001986/timecircuits-A10001986.ino) for detailed build and upload information, or, if you don't want to deal with source code, compilers and all that nerd stuff, go [here](https://install.out-a-ti.me) and follow the instructions.
68+
</details>
6269

6370
### Sound-pack installation
6471

65-
The firmware comes with a sound-pack which needs to be installed separately. The sound-pack is not updated as often as the firmware itself. If you have previously installed the latest version of the sound-pack, you normally don't have to re-install it when you update the firmware. Only if the TCD displays "PLEASE INSTALL SOUND PACK" during boot, a re-installation/update is needed.
72+
The firmware comes with a sound-pack which needs to be installed separately. The sound-pack is not updated as often as the firmware itself. If you have previously installed the latest version of the sound-pack, you normally don't have to re-install it when you update the firmware. There will be a message in the Config Portal and the TCD will display "PLEASE INSTALL SOUND PACK" during boot when a new sound-pack needs to be installed.
6673

6774
_Note that installing the sound-pack requires an [SD card](#sd-card)._
6875

69-
>A10001986 and CircuitSetup use different sound-packs. If you switch from one version to the other, the matching sound-pack must be re-installed. [A10001986-releases](https://github.com/realA10001986/Time-Circuits-Display/releases) use "sound-pack-twXX", while [CircuitSetup's](https://github.com/CircuitSetup/Time-Circuits-Display/releases) are named "sound-pack-csXX".
76+
>A10001986 and CircuitSetup use different sound-packs. If you switch from one version to the other, the matching sound-pack must be re-installed. [A10001986-releases](https://github.com/realA10001986/Time-Circuits-Display/releases) use "sound-pack-twXX", while [CircuitSetup's](https://github.com/CircuitSetup/Time-Circuits-Display/releases) are named "sound-pack-csXX". The Config Portal will tell you which version is required to be installed.
7077
7178
The first step is to extract the zipped sound-pack (which is included in every Release package). It contains one file named "TCDA.bin".
7279

7380
Next, head to the [Config Portal](#the-config-portal), click on *Update*, select the "TCDA.bin" file in the bottom file selector and click on *Upload*.
7481

7582
<details>
76-
<summary>More...</summary>
83+
<summary>Alternative way</summary>
7784

7885
Alternatively, you can install the sound-pack the following way:
7986
- Using a computer, copy "TCDA.bin" to the root directory of a FAT32 formatted SD card;

0 commit comments

Comments
 (0)