From ac19bc49d6c95c239a874f515c3771e1a9be9763 Mon Sep 17 00:00:00 2001 From: Rob Tillaart Date: Mon, 7 Nov 2022 14:58:44 +0100 Subject: [PATCH] Develop (#6) * add changelog.md --- .arduino-ci.yml | 21 +++++++++++++- CHANGELOG.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 12 +++++--- fraction.cpp | 21 ++------------ fraction.h | 4 +-- library.json | 2 +- library.properties | 2 +- 7 files changed, 103 insertions(+), 28 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.arduino-ci.yml b/.arduino-ci.yml index e7cb463..9947b71 100644 --- a/.arduino-ci.yml +++ b/.arduino-ci.yml @@ -1,3 +1,18 @@ +platforms: + rpipico: + board: rp2040:rp2040:rpipico + package: rp2040:rp2040 + gcc: + features: + defines: + - ARDUINO_ARCH_RP2040 + warnings: + flags: + +packages: + rp2040:rp2040: + url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json + compile: # Choosing to run compilation tests on 2 different Arduino platforms platforms: @@ -8,4 +23,8 @@ compile: - m4 - esp32 # - esp8266 - # - mega2560 \ No newline at end of file + # - mega2560 + - rpipico + + libraries: + - "printHelpers" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f3efd62 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,69 @@ +# Change Log fraction + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + + +## [0.1.14] - 2022-11-07 +- add changelog.md +- add rp2040 to build-CI +- update readme.md + + +## [0.1.13] - 2021-12-18 +- update library.json +- update license +- minor edits + +## [0.1.12] - 2021-11-01 +- update Arduino-CI +- add badges +- refactor + +## [0.1.11] - 2020-12-23 +- add Arduino-CI + unit tests + +## [0.1.10] - 2020-06-10 +- fix library.json + +---- + +Long time ago .... + +## [0.1.9] +- refactor + +## [0.1.8] +- refactor made constructors explicit +- fix issue #33 double --> float + +## [0.1.07] +- major refactoring by Chris-A + +## [0.1.06] +- added proper(), mediant(), angle() + +## [0.1.05] +- tested negative Fractions math +- added constructors, +- minor refactoring + +## [0.1.04] +- stabilizing code +- add simplify() for some code paths. + +## [0.1.03] +- add toDouble() +- tested several fractionize() codes +- bug fixes. + +## [0.1.02] +- faster fractionize code + +## [0.1.01] +- some fixes + +## [0.1.00] +- initial version \ No newline at end of file diff --git a/README.md b/README.md index 9fb1bbd..ea409dc 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,16 @@ The library is reasonably tested, and if problems arise please let me know. ## Future +#### must - improve documentation -- extend unit tests -- experiment with bigger nominator/denominator using all of 32767 possibilities ? +- test test test ... + +#### should - investigate divide by zero errors - investigate better fractionize() - depends on nom/denom size -- test test test ... + +#### could +- extend unit tests +- experiment with bigger nominator/denominator using all of 32767 possibilities ? - add famous constants as Fraction e.g FRAC_PI = (355, 113) ?? -- diff --git a/fraction.cpp b/fraction.cpp index 55cb266..71a5df5 100644 --- a/fraction.cpp +++ b/fraction.cpp @@ -1,28 +1,11 @@ // // FILE: fraction.cpp // AUTHOR: Rob Tillaart -// VERSION: 0.1.13 +// VERSION: 0.1.14 // PURPOSE: Arduino library to implement a Fraction datatype // URL: https://github.com/RobTillaart/Fraction // -// -// HISTORY -// 0.1.13 2021-12-18 update library.json, license, minot edits -// 0.1.12 2021-11-01 update Arduino-CI, badges, -// refactor -// 0.1.11 2020-12-23 arduino-CI + unit tests -// 0.1.10 2020-06-10 fix library.json -// 0.1.9 refactor -// 0.1.8 refactor made constructors explicit; fix issue #33 double --> float -// 0.1.07 major refactoring by Chris-A -// 0.1.06 added proper(), mediant(), angle(); -// 0.1.05 tested negative Fractions math, added constructors, -// minor refactoring, -// 0.1.04 stabilizing code, add simplify() for some code paths. -// 0.1.03 added toDouble(), tested several fractionize() codes, bug fixes. -// 0.1.02 faster fractionize code -// 0.1.01 some fixes -// 0.1.00 initial version +// HISTORY: see changelog.md #include "fraction.h" diff --git a/fraction.h b/fraction.h index bf09726..2789499 100644 --- a/fraction.h +++ b/fraction.h @@ -2,7 +2,7 @@ // // FILE: fraction.h // AUTHOR: Rob Tillaart -// VERSION: 0.1.13 +// VERSION: 0.1.14 // PURPOSE: Arduino library to implement a Fraction datatype // URL: https://github.com/RobTillaart/Fraction // @@ -10,7 +10,7 @@ #include "Arduino.h" -#define FRACTION_LIB_VERSION (F("0.1.13")) +#define FRACTION_LIB_VERSION (F("0.1.14")) class Fraction: public Printable diff --git a/library.json b/library.json index 8abbe6f..d66af0a 100644 --- a/library.json +++ b/library.json @@ -15,7 +15,7 @@ "type": "git", "url": "https://github.com/RobTillaart/Fraction.git" }, - "version": "0.1.13", + "version": "0.1.14", "frameworks": "arduino", "platforms": "*", "headers": "fraction.h" diff --git a/library.properties b/library.properties index c952d9c..697709f 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=Fraction -version=0.1.13 +version=0.1.14 author=Rob Tillaart maintainer=Rob Tillaart sentence=Arduino library to implement a Fraction datatype