From 0836907c1f244b93cc6b37141ed50c7194c9391a Mon Sep 17 00:00:00 2001 From: Terry Moore Date: Tue, 25 Dec 2018 21:09:57 -0500 Subject: [PATCH 1/4] Fix #16: update library.properties name= value --- library.properties | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library.properties b/library.properties index 553115c..bcfbfd7 100644 --- a/library.properties +++ b/library.properties @@ -1,4 +1,4 @@ -name=Catena MCCI Arduino Development Kit (ADK) +name=MCCI Arduino Development Kit ADK version=0.1.4 author=Terry Moore, ChaeHee Won maintainer=MCCI Corporation From f69ea48fdb63195ecfcd18185ed45e357279d354 Mon Sep 17 00:00:00 2001 From: Terry Moore Date: Tue, 25 Dec 2018 21:11:39 -0500 Subject: [PATCH 2/4] Clean up documentation in library.properties --- library.properties | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/library.properties b/library.properties index bcfbfd7..75ad353 100644 --- a/library.properties +++ b/library.properties @@ -2,8 +2,8 @@ name=MCCI Arduino Development Kit ADK version=0.1.4 author=Terry Moore, ChaeHee Won maintainer=MCCI Corporation -sentence=MCCI's XDK ported to Arduino -paragraph=The mcciadk is MCCI's portability toolkit, allowing for code to be reused in multiple environments. +sentence=The MCCI XDK ported to Arduino. +paragraph=The MCCI XDK is a portability toolkit, allowing for C code to be reused in multiple embedded environments. The ADK is a stripped-down version for Arduino and other deeply-embedded environments. category=Other url=https://github.com/mcci-catena/Catena-mcciadk architectures=* From 081c1cd3d7227f5e348e4af6030932fb1d595f4a Mon Sep 17 00:00:00 2001 From: Terry Moore Date: Tue, 25 Dec 2018 21:13:10 -0500 Subject: [PATCH 3/4] Clean up README.md, trim whitespace --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 29f75e5..cb1d095 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,7 @@ This repository contains the MCCI® ADK, a version of the MCCI XDK adapted fo - [Support Open Source Hardware](#support-open-source-hardware) + ## Introduction MCCI uses its XDK (cross-platform development kit) for writing portable code for use across development environments, compilers and operating systems. Although we don't think it's really appropriate for Arduino work, we find some of its idioms extremely useful, along with some of the functions. @@ -113,16 +114,16 @@ This header file provides a number of portable APIs for use by ADK clients. - `McciAdkLib_CharIsLower()`, `McciAdkLib_CharIsPrint()`, `McciAdkLib_CharIsUpper()`, `McciAdkLib_CharIsWhite()`, and `McciAdkLib_CharToLower()` duplicate some of the functions of ``. They're justified because they avoid Unicode and other portability distractions in embedded systems with small memory. -- `McciAdkLib_StringCompareCaseInsensitive()` compares two ASCII strings without considering case, and also without internationalization considerations. +- `McciAdkLib_StringCompareCaseInsensitive()` compares two ASCII strings without considering case, and also without internationalization considerations. - `McciAdkLib_MultiSzIndex()` is used for handling arrays of string values. Rather than using an array of `char*` pointers, you simply write the values into a string constant separated by "\0" values. For example, for three values, you might write: ```c++ - char my_list[] = - "one" "\0" - "two" "\0" - "three" "\0" - ; + char my_list[] = + "one" "\0" + "two" "\0" + "three" "\0" + ; ``` Then, `McciAdkLib_MultiSzIndex(my_list, 0)` will return a pointer to `"one"`, `McciAdkLib_MultiSzIndex(my_list, 1)` will return `"two"`, and `McciAdkLib_MultiSzIndex(my_list, 2)` will return `"three"`. Other indices will return `nullptr`. @@ -147,7 +148,6 @@ If you find a bug you can submit an issue here on github: https://github.com/mcci-catena/Cantea-mcciadk/issues - Before posting a new issue, please check if the same problem has been already reported by someone else to avoid duplicates. ## License and Credits @@ -164,7 +164,7 @@ Terry Moore and ChaeHee Won of MCCI were the pricipal contributors to the code i MCCI and MCCI Catena are registered trademarks of MCCI Corporation. All other trademarks are the properties of their respective owners. -### Support Open Source Hardware +### Support Open Source Hardware MCCI invests time and resources providing this open source code, please support MCCI and open-source hardware by purchasing products from MCCI, Adafruit and other open-source hardware/software vendors! From 730c8643af28def2ca0f56122737e15fef18dcea Mon Sep 17 00:00:00 2001 From: Terry Moore Date: Tue, 25 Dec 2018 21:14:23 -0500 Subject: [PATCH 4/4] Prepare for v0.2.0 release --- README.md | 5 ++++- VERSION.txt | 2 +- library.properties | 2 +- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cb1d095..4feac94 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,11 @@ This repository contains the MCCI® ADK, a version of the MCCI XDK adapted for use on Catena®-like Arduinos by [MCCI Corporation](http://www.mcci.com). -[![GitHub release](https://img.shields.io/github/release/mcci-catena/Catena-mcciadk.svg)](https://github.com/mcci-catena/arduino-lorawan/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/Catena-mcciadk/latest.svg)](https://github.com/mcci-catena/Catena-mcciadk/compare/v0.1.4...master) +[![GitHub release](https://img.shields.io/github/release/mcci-catena/Catena-mcciadk.svg)](https://github.com/mcci-catena/arduino-lorawan/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/mcci-catena/Catena-mcciadk/latest.svg)](https://github.com/mcci-catena/Catena-mcciadk/compare/v0.2.0...master) [![Build Status](https://travis-ci.com/mcci-catena/Catena-mcciadk.svg?branch=master)](https://travis-ci.com/mcci-catena/Catena-mcciadk) **Contents** + - [Introduction](#introduction) @@ -138,6 +139,8 @@ This header file provides a number of portable APIs for use by ADK clients. ## Release History +- v0.2.0 is a minor release. The only difference is in library.properties, renaming the library "MCCI Arduino Development Kit ADK" to comply with naming restrictions (issue [#16](https://github.com/mcci-catena/Catena-mcciadk/issues/16)). Also, we discovered a typo in the release tag itself for v0.1.4; the tag says v0.1.14. Rather than fixing this or jumping to v0.1.15, we jumped to v0.2.0. + - v0.1.4 is a minor release. It adds `McciAdkLib_SafeCopyString()` (issue [#8](https://github.com/mcci-catena/Catena-mcciadk/issues/8)). Fixed a bug due to use of dot_a_linkage (issue [#10](https://github.com/mcci-catena/Catena-mcciadk/issues/10)). CI testing was extended to the MCCI STM32-based board support package (v2.0.0 or later). - v0.1.3 adds documentation, continuous integration with Travis CI, and fixes some compile warnings. diff --git a/VERSION.txt b/VERSION.txt index 8c43fb4..1474d00 100644 --- a/VERSION.txt +++ b/VERSION.txt @@ -1 +1 @@ -v0.1.4 +v0.2.0 diff --git a/library.properties b/library.properties index 75ad353..5bdec83 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=MCCI Arduino Development Kit ADK -version=0.1.4 +version=0.2.0 author=Terry Moore, ChaeHee Won maintainer=MCCI Corporation sentence=The MCCI XDK ported to Arduino.