arduino_ci 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +24 -2
  3. data/lib/arduino_ci/version.rb +1 -1
  4. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cad9df4f8ade3fbe801da837c8b6a73d129c9a5497e1d43b4f655de8d9b5b640
4
- data.tar.gz: b42f9624e6af593c467d0f67a94b0695fb36b584d740f4fc38e256b8f703c075
3
+ metadata.gz: 1f12b230f52188bc1a02a1658ad488249b8f7186b00571192888a618adfcee39
4
+ data.tar.gz: 546ddcd2638c8a069294b84b76a27c88bb09677d9cb41722716430c689aaeb2e
5
5
  SHA512:
6
- metadata.gz: 25d40817ac30d531979d197768aad671e8efa9b3e2bc023fde41f3dbcbbb1b829a4f6a9915714a6eec2e1e234f2f70749390802431af81a7b23cf8b847a39750
7
- data.tar.gz: 9ef54c3d3fc6704ad70d347b85f2fc039d697a81edfafaa3e9fea329cc20c0a0919f42267452e4f62be5d508460f38a3264f04b0c51ea98a3b98062cc4bd18b1
6
+ metadata.gz: 7ddce33ab22909fc7d0404ff52e433ef8c5def5bd41380c08bad66e44ebd72e0f66341564fbd36aa0a9ba407de676722032bb4df00c170de378ce5ab1ba78f87
7
+ data.tar.gz: 648129215db16ccba65b2e02d3aa8c8a8807a6ee9baa9d6801791c3d266bd20eb755cecdc55238b9ba60b1095202e1ae002dbf15d822ee95a70399ecc427623f
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  [![Gem Version](https://badge.fury.io/rb/arduino_ci.svg)](https://rubygems.org/gems/arduino_ci)
2
2
  [![Build Status](https://travis-ci.org/ifreecarve/arduino_ci.svg)](https://travis-ci.org/ifreecarve/arduino_ci)
3
- [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.0)
3
+ [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/arduino_ci/0.1.1)
4
4
 
5
5
  # ArduinoCI Ruby gem (`arduino_ci`)
6
6
 
@@ -26,7 +26,29 @@ script:
26
26
  - bundle exec arduino_ci_remote.rb
27
27
  ```
28
28
 
29
- That's literally all there is to it on the repository side. You'll need to go to https://travis-ci.org/profile/ and enable testing for your Arduino project. Once that happens, you should be all set.
29
+ That's literally all there is to it on the repository side. You'll need to go to https://travis-ci.org/profile/ and enable testing for your Arduino project. Once that happens, you should be all set. The script will test all example projects of the library and all unit tests.
30
+
31
+ ### Unit tests in `test/`
32
+
33
+ All `.cpp` files in the `test/` directory of your Arduino library are assumed to contain unit tests. Each and every one will be compiled and executed on its own.
34
+
35
+ The most basic unit test file is as follows:
36
+
37
+ ```C++
38
+ #include <ArduinoUnitTests.h>
39
+ #include "../do-something.h"
40
+
41
+ unittest(your_test_name)
42
+ {
43
+ assertEqual(4, doSomething());
44
+ }
45
+
46
+ int main(int argc, char *argv[]) {
47
+ return Test::run_and_report(argc, argv);
48
+ }
49
+ ```
50
+
51
+ This test defines one `unittest` (a macro provided by `ArduionUnitTests.h`), called `your_test_name`, which makes some assertions on the target library. The `int main` section is boilerplate.
30
52
 
31
53
 
32
54
  ## More Documentation
@@ -1,3 +1,3 @@
1
1
  module ArduinoCI
2
- VERSION = "0.1.0".freeze
2
+ VERSION = "0.1.1".freeze
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: arduino_ci
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ian Katz