Skip to content

Commit

Permalink
update readme.md (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobTillaart committed Nov 14, 2023
1 parent cef8629 commit 020a988
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 13 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [0.2.6] - 2023-11-14
- update readme.md


## [0.2.5] - 2023-02-08
- update readme.md
- fix keywords.txt
- improve measurement - nibbleArray_performance.ino
- update GitHub actions
- update license 2023


## [0.2.4] - 2022-11-18
- add RP2040 in build-CI
- add changelog.md
Expand Down
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,11 @@
[![Arduino CI](https://github.com/RobTillaart/nibbleArray/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/nibbleArray/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/nibbleArray/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/nibbleArray/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/nibbleArray/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/nibbleArray.svg)](https://github.com/RobTillaart/nibbleArray/issues)

[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/nibbleArray/blob/master/LICENSE)
[![GitHub release](https://img.shields.io/github/release/RobTillaart/nibbleArray.svg?maxAge=3600)](https://github.com/RobTillaart/nibbleArray/releases)
[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/nibbleArray.svg)](https://registry.platformio.org/libraries/robtillaart/nibbleArray)


# nibbleArray
Expand Down Expand Up @@ -35,7 +38,6 @@ The BitArray library is one from a set of three:
- https://github.com/RobTillaart/nibbleArray for elements of 4 bits or smaller (values 0 .. 15).



## Interface

```cpp
Expand Down Expand Up @@ -68,7 +70,6 @@ If value > 15 it will be truncated.
- add a begin() function that does the work now done in constructor (0.3.0)
- similar to bitArray and BoolArray classes.


#### Should

- align interface with BoolArray and bitArray.
Expand All @@ -77,14 +78,21 @@ If value > 15 it will be truncated.
- allow larger allocations for non AVR, how?
- don't test for size, user responsibility?


#### Could

- implement NIBBLEARRAY_ERROR_VALUE for set and setAll ??
- for now user responsibility.


#### Won't
#### Wont

- setAll( f() ) - fill the array by calling a function n times?


## Support

If you appreciate my libraries, you can support the development and maintenance.
Improve the quality of the libraries by providing issues and Pull Requests, or
donate through PayPal or GitHub sponsors.

Thank you,

4 changes: 2 additions & 2 deletions library.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"type": "git",
"url": "https://github.com/RobTillaart/nibbleArray.git"
},
"version": "0.2.5",
"version": "0.2.6",
"license": "MIT",
"frameworks": "arduino",
"frameworks": "*",
"platforms": "*",
"headers": "nibbleArray.h"
}
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=NibbleArray
version=0.2.5
version=0.2.6
author=Rob Tillaart <[email protected]>
maintainer=Rob Tillaart <[email protected]>
sentence=Library to implement a compact array of nibbles (4 bit).
Expand Down
2 changes: 1 addition & 1 deletion nibbleArray.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//
// FILE: nibbleArray.cpp
// AUTHOR: Rob Tillaart
// VERSION: 0.2.5
// VERSION: 0.2.6
// PURPOSE: Arduino library for a compact array of nibbles (4 bits)
// URL: https://github.com/RobTillaart/nibbleArray

Expand Down
5 changes: 2 additions & 3 deletions nibbleArray.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,15 @@
//
// FILE: nibbleArray.h
// AUTHOR: Rob Tillaart
// VERSION: 0.2.5
// VERSION: 0.2.6
// PURPOSE: Arduino library for a compact array of nibbles (4 bits)
// URL: https://github.com/RobTillaart/nibbleArray
//


#include "Arduino.h"


#define NIBBLEARRAY_LIB_VERSION (F("0.2.5"))
#define NIBBLEARRAY_LIB_VERSION (F("0.2.6"))


#ifndef NIBBLEARRAY_MAXSIZE
Expand Down

0 comments on commit 020a988

Please sign in to comment.