Skip to content

Commit d19351c

Browse files
authored
Merge pull request #340 from hlovdal/doc_updates.m
Some minor documentation changes
2 parents 137ee77 + 7cba652 commit d19351c

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
160160
## [0.4.0] - 2020-11-21
161161
### Added
162162
- `arduino_ci_remote.rb` CLI switch `--skip-examples-compilation`
163-
- Add support for `diditalPinToPort()`, `digitalPinToBitMask()`, `portOutputRegister()`, and `portInputRegister()`
163+
- Add support for `digitalPinToPort()`, `digitalPinToBitMask()`, `portOutputRegister()`, and `portInputRegister()`
164164
- `CppLibrary.header_files` to find header files
165165
- `LibraryProperties` to read metadata from Arduino libraries
166166
- `CppLibrary.library_properties_path`, `CppLibrary.library_properties?`, `CppLibrary.library_properties` to expose library properties of a Cpp library

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,21 @@ Pull requests will trigger a CI job. The following two commands will be expecte
1313

1414
* `bundle exec rubocop -D .` - code style tests
1515
* `bundle exec rspec` - functional tests
16+
* `bundle exec rspec spec/some_file_spec.rb` - functional tests for just some file
1617

1718
If you do not already have a working ruby development environment set up, run the following commands:
1819

1920
```shell
21+
# One of the following
2022
apt-get install ruby ruby-dev # For Debian/Ubuntu
21-
dnf install ruby ruby-devel # For Fedora
22-
yum install ruby ruby-devel # For Centos/RHEL
23+
dnf install ruby ruby-devel # For Fedora/newer Centos/RHEL
24+
yum install ruby ruby-devel # For older Centos/RHEL
25+
26+
# All below
2327
gem install bundler
28+
gem install rspec
29+
# Now you are ready to install dependencies with bundle (as described in the
30+
# README file) and to run unit tests.
2431
```
2532

2633
Be prepared to write tests to accompany any code you would like to see merged.

0 commit comments

Comments
 (0)