Skip to content

Commit 8edc7f1

Browse files
committed
Added documentation for installation
1 parent e1a17d7 commit 8edc7f1

File tree

6 files changed

+72
-1
lines changed

6 files changed

+72
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,29 @@ The DCF77 Library download. Example sketches have been added to
1212

1313
Additional documentation and full explanations of the samples can be found in these blog
1414
posts on DCF Hardware, DCF Signal can be found here:
15-
http://thijs.elenbaas.net/2012/04/arduino-dcf77-radio-clock-receiver-library/
15+
[http://thijs.elenbaas.net/2012/04/arduino-dcf77-radio-clock-receiver-library/](http://thijs.elenbaas.net/2012/04/arduino-dcf77-radio-clock-receiver-library/)
16+
17+
18+
## Downloading
19+
20+
This package can be downloaded in different manners
21+
22+
23+
- The Arduino Library Manager: [see here how to use it](http://www.arduino.cc/en/guide/libraries#toc3).
24+
- The PlatformIO package manager: [see here how to use it](http://www.ikravets.com/computer-life/platformio/2014/10/07/integration-of-platformio-library-manager-to-arduino-and-energia-ides).
25+
- By directly loading fetching the Archive from GitHub:
26+
1. Go to [https://github.com/thijse/Arduino-DCF77](https://github.com/thijse/Arduino-DCF77)
27+
2. Click the DOWNLOAD ZIP button in the panel on the
28+
3. Rename the uncompressed folder **Arduino-DCF77-master** to **DCF77**.
29+
4. You may need to create the libraries subfolder if its your first library.
30+
5. Place the **DCF77** library folder in your **arduinosketchfolder/libraries/** folder.
31+
5. Restart the IDE.
32+
6. For more information, [read this extended manual](http://thijs.elenbaas.net/2012/07/installing-an-arduino-library/)
33+
- If you want to have a package that includes all referenced libraries, use the pre-packaged library
34+
1. Download the package as a zipfile [here](https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.zip?raw=true) or as a tarball [here ](https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.tar.gz?raw=true).
35+
2. Copy the folders inside the **libraries** folder to you your **arduinosketchfolder/libraries/** folder.
36+
3. Restart the IDE.
37+
3. For more information, [read this extended manual](http://thijs.elenbaas.net/2012/07/installing-an-arduino-library/)
1638

1739
##Samples
1840

@@ -171,5 +193,7 @@ can be found here:
171193
- [http://www.arduino.cc/en/Main/Libraries](http://www.arduino.cc/en/Main/Libraries)
172194
- [http://www.arduino.cc/en/Reference/Libraries](http://www.arduino.cc/en/Reference/Libraries)
173195

196+
## Copyright
174197

198+
DCF77 is provided Copyright © 2013,2014,2015 under LGPL License.
175199

examples/DCFBinaryStream/DCFBinaryStream.pde

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@
1010
In order for this example to give output from the DCF library,
1111
make sure that logging is turned on in the DCF library. You can
1212
do this by adding the #define VERBOSE_DEBUG 1 in Utils.cpp.
13+
14+
NOTE: If you used a package manager to download the DCF77 library,
15+
make sure have also fetched these libraries:
16+
17+
* Time
18+
19+
A package that includes all referenced libraries can be found at:
20+
https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.zip?raw=true
21+
1322
*/
1423

1524

examples/DCFSignal/DCFSignal.pde

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88
Pulse-to-Pulse is approximately 1000 ms and pulse with is approx 100ms or 200ms
99
The axis underestimates the elapsed time slightly, because a single loop takes a bit
1010
longer than 10ms.
11+
12+
NOTE: If you used a package manager to download the DCF77 library,
13+
make sure have also fetched these libraries:
14+
15+
* Time
16+
17+
A package that includes all referenced libraries can be found at:
18+
https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.zip?raw=true
1119
*/
1220

1321
#define BLINKPIN 13

examples/InternalClockSync/InternalClockSync.pde

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88
the internal clock. In order for this example to give clear output,
99
make sure that you disable logging from the DCF library. You can
1010
do this by commenting out #define VERBOSE_DEBUG 1 in Utils.cpp.
11+
12+
NOTE: If you used a package manager to download the DCF77 library,
13+
make sure have also fetched these libraries:
14+
15+
* Time
16+
17+
A package that includes all referenced libraries can be found at:
18+
https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.zip?raw=true
19+
1120
*/
1221

1322
#include "DCF77.h"

examples/SyncProvider/SyncProvider.pde

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@
88
the internal clock. In order for this example to give clear output,
99
make sure that you disable logging from the DCF library. You can
1010
do this by commenting out #define VERBOSE_DEBUG 1 in Utils.cpp.
11+
12+
NOTE: If you used a package manager to download the DCF77 library,
13+
make sure have also fetched these libraries:
14+
15+
* Time
16+
17+
A package that includes all referenced libraries can be found at:
18+
https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.zip?raw=true
19+
1120
*/
1221

1322
#include <DCF77.h> //https://github.com/thijse/Arduino-Libraries/downloads

examples/TimeZones/TimeZones.pde

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@
88
the internal clock. In order for this example to give clear output,
99
make sure that you disable logging from the DCF library. You can
1010
do this by commenting out #define VERBOSE_DEBUG 1 in Utils.cpp.
11+
12+
NOTE: If you used a package manager to download the DCF77 library,
13+
make sure have also fetched these libraries:
14+
15+
* Time
16+
* Timezone
17+
18+
A package that includes all referenced libraries can be found at:
19+
https://github.com/thijse/Zipballs/blob/master/DCF77/DCF77.zip?raw=true
20+
21+
22+
1123
*/
1224

1325
#include <DCF77.h> //https://github.com/thijse/Arduino-Libraries/downloads

0 commit comments

Comments
 (0)