README.txt: fixed phrasing and link anchor to arscons.
[fuzzy_alarm_clock.git] / README.txt
blobccf0a80085498e6b3885f538a1944daccfaa1b1b
1 ===================
2  Fuzzy Alarm Clock
3 ===================
5 ---------------------------------------------------
6  by Elena ``of Valhalla'' Grandi and Diego Roversi
7 ---------------------------------------------------
9 The Fuzzy Alarm Clock is a device that conveys just the temporal informations 
10 needed during the night, and nothing else.
12 There is no time/date display, but coloured LEDs are used to show an 
13 aproximation of the time until (and since) alarm time, and 
14 an old PC speaker works as the Sound Emitting Device.
16 Design notes and additional descriptions are available on the `web page
17 <http://www.trueelena.org/computers/projects/fuzzy_alarm_clock.html>`_.
19 Requirements
20 ============
22 Arduino sketch
23 --------------
25 The arduino sketch ``fuzzy_alarm_clock_ds1307`` requires an old (<1.0) 
26 version of the arduino tools and can be built outside the IDE 
27 thanks to the SConstruct file from arscons_.
28 It also requires an old (pre 1.0 migration) version of the
29 RealTimeClockDS1307_ library by davidhbrown.
31 .. _arscons: http://code.google.com/p/arscons/
32 .. _RealTimeClockDS1307: https://github.com/davidhbrown/RealTimeClockDS1307
34 Conversion to arduino 1.0 is planned as soon as a compatible
35 SConstruct file will be available.
37 Schematics
38 ----------
40 This repository includes the kicad project 
42 Beside the standard libraries, I've used the `Arduino Shield Modules for 
43 KiCad V3` by nicholasclewis; the needed component has been included by kicad 
44 in the ``fuzzy_alarm_clock_ds1307-cache.lib`` file.
46 .. _`Arduino Shield Modules for KiCad V3`: http://www.thingiverse.com/thing:9630
48 An `SVG rendering of the schematics`_ is available on the web page, 
49 but during active developement it could reflect an older version.
51 .. _`SVG rendering of the schematics`: http://www.trueelena.org/computers/projects/fuzzy_alarm_clock/fuzzy_alarm_clock_ds1307.svg