Skip to content

Commit

Permalink
Added warning for unfinished documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
florianL21 committed Apr 17, 2021
1 parent db82ba6 commit b72e71c
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
<img src="https://github.com/florianL21/LED-ClockShelf/blob/master/doc/images/Animation.gif?raw=true" alt="Animation example"/>
</p>

------------------

ATTENTION: You are looking at version 2.0 of the project. Documentation for this version is still a Work In Progress!
For Version 1.0 take a look at [this snapshot branch](https://github.com/florianL21/LED-ClockShelf/tree/Snapshot-v1)
You wil also find the original version of the documentation there.

------------------

This is the software of a variation of the LED clock from [DIY Machines](https://www.instructables.com/id/How-to-Build-a-Giant-Hidden-Shelf-Edge-Clock/)
A configuration which works on the original version of the clock is also part of the source code.

Expand All @@ -14,7 +22,7 @@ Further animations can be easily added and existing animation can be adjusted to

The whole codebase is highly modular and configurable and can be tweaked exactly to your preferences.

Detailed documentation is available on the [Wiki.](https://giant-led-clock.readthedocs.io/)
Detailed documentation is available on [read the docs.](https://giant-led-clock.readthedocs.io/)

If you are interested in my variation of the design which uses a lot of wood instead of the 3D prints and is a bit bigger than the original you can find it on [thingiverse here](https://www.thingiverse.com/thing:4352352)

Expand Down

0 comments on commit b72e71c

Please sign in to comment.