Skip to content

Commit 20384e3

Browse files
committed
readme updates to reflect conditional libraries
1 parent 6ec722c commit 20384e3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This feature can count up (chrono) or down (timer), up to 100 hours each way. Wh
6767
> **Hardware variations**
6868
> * If your clock has a [switched relay](#hardware-configuration) and the chrono/timer is [set to use it](#optionstimer), it will switch on while the timer is running, like the “sleep” function on a clock radio. The runout options will still work, but won’t signal.
6969
> * If your clock does not have a beeper, the runout options cannot be set.
70-
> * If your clock uses a rotary encoder for **Up/Down** rather than buttons, **Down** will stop the chrono/timer, and **Up** will display lap times (chrono) and cycle through runout options (timer).
70+
> * If your clock uses a rotary encoder for **Up/Down** rather than buttons, while running, **Up** will display lap times (chrono) and cycle through runout options (timer), and **Down** will stop. To prevent accidental resets, **Down** does nothing while stopped. To reset to `0`, simply switch to another display while stopped.
7171
7272
## The Alt button
7373

@@ -150,11 +150,12 @@ You can also set the **defaults for the options menu** (in main code, currently)
150150

151151
## Compiling the sketch
152152

153-
**To compile the sketch,** ensure these libraries are added and enabled in your Arduino IDE, via the Library Manager:
153+
**To compile the sketch,** ensure these libraries are installed in your Arduino IDE via Library Manager, as needed:
154154

155155
* Wire (Arduino built-in)
156156
* EEPROM (Arduino built-in)
157-
* DS3231 ([NorthernWidget](https://github.com/NorthernWidget/DS3231))
158-
* Dusk2Dawn ([dmkishi](https://github.com/dmkishi/Dusk2Dawn))
157+
* [DS3231](https://github.com/NorthernWidget/DS3231) by NorthernWidget
158+
* [Dusk2Dawn](https://github.com/dmkishi/Dusk2Dawn) by DM Kishi - if sunrise/sunset display is enabled
159+
* [Encoder](https://github.com/PaulStoffregen/Encoder) by Paul Stoffregen - if rotary encoder is equipped
159160

160161
**To upload the sketch to your clock,** if it doesn’t appear in the IDE’s Ports menu (as a USB port), your UNDB may be equipped with an Arduino clone that requires [drivers for the CH340 chipset](https://sparks.gogo.co.nz/ch340.html).

0 commit comments

Comments
 (0)