0.3.1 weight

libraries/weight/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.1] - 2023-11-23
+- update readme.md
+
+
 ## [0.3.0] - 2023-08-29
 - rename class **weightConvertor** to **weightConverter**
 - add **adders** to the weightConverter to add different units of weight.

libraries/weight/README.md

@@ -21,6 +21,19 @@ Weight.h is a library containing weight conversion functions.
 Open for additions, including obscure weight metrics or
 weight related math functions and constants.
 
+
+#### Overview of conversions:
+
+```
+          stone - lbs - ounce
+            |      |      |
+           kilo   kilo - gram
+
+
+           kilo - (stone, lbs, ounce)
+```
+
+
 #### Related
 
 - https://github.com/RobTillaart/AtomicWeight
@@ -31,15 +44,8 @@ weight related math functions and constants.
 
 ## Interface
 
-Overview of conversions:
+```cpp
-
+#include "weight.h"
-```
-          stone - lbs - ounce
-            |      |      |
-           kilo   kilo - gram
-
-
-           kilo - (stone, lbs, ounce)
 ```
 
 Functions are straightforward.
@@ -85,6 +91,9 @@ Since version 0.3.0 the converter can also add different units.
 
 ## Interface
 
+```cpp
+#include "weight.h"
+```
 
 #### Constructor
 
@@ -153,9 +162,11 @@ Since version 0.3.0 the converter can also add different units.
 - **float getGrain()**
 - **float getCarat()**
 
+
 ## Future
 
 #### Must
+
 - improve documentation
   - where are units used
 
@@ -163,10 +174,12 @@ Since version 0.3.0 the converter can also add different units.
 
 
 #### Could
-- create data types of stone lbs kilo etc.?
 
+- create data types of stone lbs kilo etc.?
+- should float be double?
 
 #### Won't (unless)
+
 - large masses - sun planets ?   (see relativity library)
 - gravity constants of planets REL or ABS eg REL_GRAVITY_EARTH 1.0
 - molarity functions

libraries/weight/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/weight.git"
   },
-  "version": "0.3.0",
+  "version": "0.3.1",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

libraries/weight/library.properties

@@ -1,5 +1,5 @@
 name=weight
-version=0.3.0
+version=0.3.1
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Library of weight conversion functions
@@ -7,5 +7,5 @@ paragraph=Kilo gram stone lbs ounce pound
 category=Signal Input/Output
 url=https://github.com/RobTillaart/weight
 architectures=*
-includes=weight.h 
+includes=weight.h
 depends=

libraries/weight/weight.h

@@ -2,7 +2,7 @@
 //
 //    FILE: weight.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 // PURPOSE: Collection weight conversion functions
 //     URL: https://github.com/RobTillaart/weight
 
@@ -10,7 +10,7 @@
 #include "Arduino.h"
 
 
-#define WEIGHT_LIB_VERSION        (F("0.3.0"))
+#define WEIGHT_LIB_VERSION        (F("0.3.1"))
 
 
 /////////////////////////////////////////////////////////////
@@ -131,7 +131,7 @@ public:
   float getCarat()      { return _w * 5; };
 
   private:
-    float _w;  //   grams
+    float _w;  //  grams
 };