Skip to content

Commit 5e9fd74

Browse files
author
Jim Lindblom
committed
Updating license and readme.
1 parent 642eb23 commit 5e9fd74

File tree

2 files changed

+98
-6
lines changed

2 files changed

+98
-6
lines changed

LICENSE.md

+52-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,57 @@
1+
SparkFun License Information
2+
============================
13

2-
License Information
3-
-------------------
4+
SparkFun uses two different licenses for our files - one for hardware and one for code.
45

5-
The hardware is released under [Creative Commons Share-alike 3.0](http://creativecommons.org/licenses/by-sa/3.0/).
6+
Hardware
7+
---------
68

7-
All other code is open source so please feel free to do anything you want with it; you buy me a beer if you use this and we meet someday ([Beerware license](http://en.wikipedia.org/wiki/Beerware)).
9+
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
10+
11+
Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
12+
13+
You are free to:
14+
15+
Share — copy and redistribute the material in any medium or format
16+
Adapt — remix, transform, and build upon the material
17+
for any purpose, even commercially.
18+
The licensor cannot revoke these freedoms as long as you follow the license terms.
19+
Under the following terms:
20+
21+
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
22+
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
23+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
24+
Notices:
25+
26+
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
27+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
28+
29+
30+
Code
31+
--------
32+
33+
**SparkFun code, firmware, and software is released under the [MIT License](http://opensource.org/licenses/MIT).**
34+
35+
The MIT License (MIT)
36+
37+
Copyright (c) 2016 SparkFun Electronics, Inc.
38+
39+
Permission is hereby granted, free of charge, to any person obtaining a copy
40+
of this software and associated documentation files (the "Software"), to deal
41+
in the Software without restriction, including without limitation the rights
42+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
43+
copies of the Software, and to permit persons to whom the Software is
44+
furnished to do so, subject to the following conditions:
45+
46+
The above copyright notice and this permission notice shall be included in all
47+
copies or substantial portions of the Software.
48+
49+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
52+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
53+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
54+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
55+
SOFTWARE.
856

957

README.md

+46-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,46 @@
1-
# SparkFun_DS3234_RTC_Arduino_Library
2-
Implements all time-keeping, setting, and alarming functions of the DS3234 RTC module.
1+
SparkFun DeadOn RTC Breakout (DS3234) Arduino Library
2+
========================================
3+
4+
[![SparkFun DeadOn RTC Breakout](https://cdn.sparkfun.com//assets/parts/4/4/5/5/10160b-01.jpg)](https://www.sparkfun.com/products/10160)
5+
6+
[*SparkFun DeadOn RTC Breakout (BOB-10160)*](https://www.sparkfun.com/products/10160)
7+
8+
Arduino library for the SPI-based DS3234 real time clock (RTC). Allows you to set and read the time and date, set both alarms, and configure the SQW output pin.
9+
10+
Repository Contents
11+
-------------------
12+
13+
* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.
14+
* **/src** - Source files for the library (.cpp, .h).
15+
* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.
16+
* **library.properties** - General library properties for the Arduino package manager.
17+
18+
Documentation
19+
--------------
20+
21+
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.
22+
* **[Product Repository](https://github.com/sparkfun/RTC-Module/tree/v1.4)** - Main repository (including hardware files) for the SparkFun DeadOn RTC Breakout.
23+
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/deadon-rtc-breakout-hookup-guide)** - Basic hookup guide for the SparkFun DeadOn RTC Breakout.
24+
25+
Products that use this Library
26+
---------------------------------
27+
28+
* [SparkFun DeadOn RTC Breakout (BOB-10160)](https://www.sparkfun.com/products/10160)- Basic breakout for the DS3234, including pull-up resistors and a coin cell battery holder.
29+
30+
Version History
31+
---------------
32+
33+
* [V_1.0.0](https://github.com/sparkfun/SparkFun_DS3234_RTC_Arduino_Library/tree/V_1.0.0) - Initial library release
34+
35+
License Information
36+
-------------------
37+
38+
This product is _**open source**_!
39+
40+
Please review the LICENSE.md file for license information.
41+
42+
If you have any questions or concerns on licensing, please contact techsupport@sparkfun.com.
43+
44+
Distributed as-is; no warranty is given.
45+
46+
- Your friends at SparkFun.

0 commit comments

Comments
 (0)