Skip to content

Commit a8b3145

Browse files
committed
Add code of conduct, license, travis, update README
1 parent 9a99d22 commit a8b3145

File tree

4 files changed

+193
-11
lines changed

4 files changed

+193
-11
lines changed

.travis.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
language: c
2+
sudo: false
3+
# Blacklist
4+
branches:
5+
except:
6+
- gh-pages
7+
cache:
8+
directories:
9+
- ~/arduino_ide
10+
- ~/.arduino15/packages/
11+
git:
12+
depth: false
13+
quiet: true
14+
env:
15+
global:
16+
- PRETTYNAME="Adafruit RTClib"
17+
# Optional, will default to "$TRAVIS_BUILD_DIR/Doxyfile"
18+
# - DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile
19+
20+
before_install:
21+
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
22+
23+
script:
24+
- build_main_platforms
25+
26+
# Generate and deploy documentation
27+
after_success:
28+
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/library_check.sh)
29+
- source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/doxy_gen_and_deploy.sh)

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2019 Adafruit Industries
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+16-11
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,37 @@
1+
# Adafruit RTClib [![Build Status](https://travis-ci.com/adafruit/RTClib.svg?branch=master)](https://travis-ci.com/adafruit/RTClib)
2+
13
This is a fork of JeeLab's fantastic real time clock library for Arduino.
24

35
For details on using this library with an RTC module like the DS1307, PCF8523, or DS3231, see the guide at: https://learn.adafruit.com/ds1307-real-time-clock-breakout-board-kit/overview
46

5-
To download. click the DOWNLOADS button to the right, and rename the uncompressed folder RTClib.
7+
Works great with Adafruit RTC breakouts:
8+
9+
- [DS3231 Precision RTC](https://www.adafruit.com/product/3013)
10+
- [PCF8523 RTC](https://www.adafruit.com/product/3295)
11+
- [DS1307 RTC](https://www.adafruit.com/product/3296)
612

7-
Place the RTClib folder in your *arduinosketchfolder*/libraries/ folder.
8-
You may need to create the libraries subfolder if its your first library. Restart the IDE.
13+
To install, use the Arduino Library Manager to search for "RTClib", find "RTClib by Adafruit" and install the library.
914

10-
Please note that dayOfTheWeek() ranges from 0 to 6 inclusive with 0 being 'Sunday'
15+
Please note that dayOfTheWeek() ranges from 0 to 6 inclusive with 0 being 'Sunday'.
1116

1217
<!-- START COMPATIBILITY TABLE -->
1318

1419
## Compatibility
1520

1621
MCU | Tested Works | Doesn't Work | Not Tested | Notes
1722
------------------ | :----------: | :----------: | :---------: | -----
18-
Atmega328 @ 16MHz | X | | |
19-
Atmega328 @ 12MHz | X | | |
23+
Atmega328 @ 16MHz | X | | |
24+
Atmega328 @ 12MHz | X | | |
2025
Atmega32u4 @ 16MHz | X | | | Use SDA/SCL on pins D3 &amp; D2
2126
Atmega32u4 @ 8MHz | X | | | Use SDA/SCL on pins D3 &amp; D2
2227
ESP8266 | X | | | SDA/SCL default to pins 4 &amp; 5 but any two pins can be assigned as SDA/SCL using Wire.begin(SDA,SCL)
2328
Atmega2560 @ 16MHz | X | | | Use SDA/SCL on Pins 20 &amp; 21
2429
ATSAM3X8E | X | | | Use SDA1 and SCL1
25-
ATSAM21D | X | | |
26-
ATtiny85 @ 16MHz | X | | |
27-
ATtiny85 @ 8MHz | X | | |
28-
Intel Curie @ 32MHz | | | X |
29-
STM32F2 | | | X |
30+
ATSAM21D | X | | |
31+
ATtiny85 @ 16MHz | X | | |
32+
ATtiny85 @ 8MHz | X | | |
33+
Intel Curie @ 32MHz | | | X |
34+
STM32F2 | | | X |
3035

3136
* ATmega328 @ 16MHz : Arduino UNO, Adafruit Pro Trinket 5V, Adafruit Metro 328, Adafruit Metro Mini
3237
* ATmega328 @ 12MHz : Adafruit Pro Trinket 3V

code-of-conduct.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Adafruit Community Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and leaders pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level or type of
9+
experience, education, socio-economic status, nationality, personal appearance,
10+
race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
We are committed to providing a friendly, safe and welcoming environment for
15+
all.
16+
17+
Examples of behavior that contributes to creating a positive environment
18+
include:
19+
20+
* Be kind and courteous to others
21+
* Using welcoming and inclusive language
22+
* Being respectful of differing viewpoints and experiences
23+
* Collaborating with other community members
24+
* Gracefully accepting constructive criticism
25+
* Focusing on what is best for the community
26+
* Showing empathy towards other community members
27+
28+
Examples of unacceptable behavior by participants include:
29+
30+
* The use of sexualized language or imagery and sexual attention or advances
31+
* The use of inappropriate images, including in a community member's avatar
32+
* The use of inappropriate language, including in a community member's nickname
33+
* Any spamming, flaming, baiting or other attention-stealing behavior
34+
* Excessive or unwelcome helping; answering outside the scope of the question
35+
asked
36+
* Trolling, insulting/derogatory comments, and personal or political attacks
37+
* Public or private harassment
38+
* Publishing others' private information, such as a physical or electronic
39+
address, without explicit permission
40+
* Other conduct which could reasonably be considered inappropriate
41+
42+
The goal of the standards and moderation guidelines outlined here is to build
43+
and maintain a respectful community. We ask that you don’t just aim to be
44+
"technically unimpeachable", but rather try to be your best self.
45+
46+
We value many things beyond technical expertise, including collaboration and
47+
supporting others within our community. Providing a positive experience for
48+
other community members can have a much more significant impact than simply
49+
providing the correct answer.
50+
51+
## Our Responsibilities
52+
53+
Project leaders are responsible for clarifying the standards of acceptable
54+
behavior and are expected to take appropriate and fair corrective action in
55+
response to any instances of unacceptable behavior.
56+
57+
Project leaders have the right and responsibility to remove, edit, or
58+
reject messages, comments, commits, code, issues, and other contributions
59+
that are not aligned to this Code of Conduct, or to ban temporarily or
60+
permanently any community member for other behaviors that they deem
61+
inappropriate, threatening, offensive, or harmful.
62+
63+
## Moderation
64+
65+
Instances of behaviors that violate the Adafruit Community Code of Conduct
66+
may be reported by any member of the community. Community members are
67+
encouraged to report these situations, including situations they witness
68+
involving other community members.
69+
70+
You may report in the following ways:
71+
72+
In any situation, you may send an email to <[email protected]>.
73+
74+
On the Adafruit Discord, you may send an open message from any channel
75+
to all Community Helpers by tagging @community helpers. You may also send an
76+
open message from any channel, or a direct message to @kattni#1507,
77+
@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or
78+
@Andon#8175.
79+
80+
Email and direct message reports will be kept confidential.
81+
82+
In situations on Discord where the issue is particularly egregious, possibly
83+
illegal, requires immediate action, or violates the Discord terms of service,
84+
you should also report the message directly to Discord.
85+
86+
These are the steps for upholding our community’s standards of conduct.
87+
88+
1. Any member of the community may report any situation that violates the
89+
Adafruit Community Code of Conduct. All reports will be reviewed and
90+
investigated.
91+
2. If the behavior is an egregious violation, the community member who
92+
committed the violation may be banned immediately, without warning.
93+
3. Otherwise, moderators will first respond to such behavior with a warning.
94+
4. Moderators follow a soft "three strikes" policy - the community member may
95+
be given another chance, if they are receptive to the warning and change their
96+
behavior.
97+
5. If the community member is unreceptive or unreasonable when warned by a
98+
moderator, or the warning goes unheeded, they may be banned for a first or
99+
second offense. Repeated offenses will result in the community member being
100+
banned.
101+
102+
## Scope
103+
104+
This Code of Conduct and the enforcement policies listed above apply to all
105+
Adafruit Community venues. This includes but is not limited to any community
106+
spaces (both public and private), the entire Adafruit Discord server, and
107+
Adafruit GitHub repositories. Examples of Adafruit Community spaces include
108+
but are not limited to meet-ups, audio chats on the Adafruit Discord, or
109+
interaction at a conference.
110+
111+
This Code of Conduct applies both within project spaces and in public spaces
112+
when an individual is representing the project or its community. As a community
113+
member, you are representing our community, and are expected to behave
114+
accordingly.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 1.4, available at
120+
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>,
121+
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
122+
123+
For other projects adopting the Adafruit Community Code of
124+
Conduct, please contact the maintainers of those projects for enforcement.
125+
If you wish to use this code of conduct for your own project, consider
126+
explicitly mentioning your moderation policy or making a copy with your
127+
own moderation policy so as to avoid confusion.

0 commit comments

Comments
 (0)