Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RobTillaart committed Nov 15, 2023
1 parent ff5e68f commit b5a9e73
Show file tree
Hide file tree
Showing 6 changed files with 47 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,11 +6,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).


## [0.1.6] - 2023-11-15
- update readme.md (badges)


## [0.1.5] - 2022-11-21
- add changelog.md
- add RP2040 to build-CI


## [0.1.4] - 2021-12-23
- update library.json
- update readme.md
Expand Down
4 changes: 2 additions & 2 deletions Prandom.cpp
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//
// FILE: Prandom.cpp
// AUTHOR: Rob dot Tillaart at gmail dot com
// VERSION: 0.1.5
// AUTHOR: Rob Tillaart
// VERSION: 0.1.6
// PURPOSE: Arduino library for random number generation with Python random interface
// URL: https://github.com/RobTillaart/Prandom
//
Expand Down
8 changes: 4 additions & 4 deletions Prandom.h
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
#pragma once
//
// FILE: Prandom.h
// AUTHOR: Rob dot Tillaart at gmail dot com
// VERSION: 0.1.5
// AUTHOR: Rob Tillaart
// VERSION: 0.1.6
// PURPOSE: Arduino library for random numbers with Python Random interface
// The underlying pseudo-random number generator is a
// Multiply-with-carry method invented by George Marsaglia.
Expand All @@ -13,7 +13,7 @@

#include "Arduino.h"

#define PRANDOM_LIB_VERSION (F("0.1.5"))
#define PRANDOM_LIB_VERSION (F("0.1.6"))


class Prandom
Expand Down Expand Up @@ -69,5 +69,5 @@ class Prandom
};


// -- END OF FILE --
// -- END OF FILE --

37 changes: 34 additions & 3 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/Prandom/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
[![Arduino-lint](https://github.com/RobTillaart/Prandom/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/Prandom/actions/workflows/arduino-lint.yml)
[![JSON check](https://github.com/RobTillaart/Prandom/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/Prandom/actions/workflows/jsoncheck.yml)
[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/Prandom.svg)](https://github.com/RobTillaart/Prandom/issues)

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


# Prandom
Expand All @@ -16,21 +19,49 @@ Arduino library for random number generation with Python random interface.
See Python Random library - https://docs.python.org/3/library/random.html


#### Related

- https://github.com/RobTillaart/DEVRANDOM
- https://github.com/RobTillaart/Prandom
- https://github.com/RobTillaart/randomHelpers


## Interface

```cpp
#include "Prandom.h"
```


## Operation

See examples.


## Future

#### must
#### Must

- improve documentation.

#### should
#### Should

- unit tests?
- follow developments in Python random library.

#### could
#### Could

- add more RNG's to choose from.

#### Wont


## 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/Prandom.git"
},
"version": "0.1.5",
"version": "0.1.6",
"license": "MIT",
"frameworks": "arduino",
"frameworks": "*",
"platforms": "*",
"headers": "Prandom.h"
}
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=Prandom
version=0.1.5
version=0.1.6
author=Rob Tillaart <[email protected]>
maintainer=Rob Tillaart <[email protected]>
sentence=Arduino library for random number generation with Python random interface.
Expand Down

0 comments on commit b5a9e73

Please sign in to comment.