Fix URL in examples + minor edits (#19)

RobTillaart · Jan 6, 2024 · 9f33beb · 9f33beb
1 parent 27c1fa6
commit 9f33beb
Show file tree

Hide file tree

Showing 17 changed files with 43 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,12 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.4.4] - 2024-01-05
+- FIx URL in examples
+- minor edits
+
+
 ## [0.4.3] - 2023-11-15
 - added **csi()** comma separated integers for readability e.g. 123,458,654
 - update readme.md.
 - update examples
 
-
 ## [0.4.2] - 2023-11-15
 - update readme.md
 - update keywords.txt

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2023 Rob Tillaart
+Copyright (c) 2018-2024 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ data in a way not possible in the standard print library of the Arduino.
 - **print64()** print **uint64_t** and **int64_t** 
 - **sci()** generates in scientific format - exponent has step 1.
 - **eng()** generates in engineering format - exponent has step 3.
-- **scieng()** generated exponential format - exponent has step 1 to 9.
+- **scieng()** generates in exponential format - exponent has step 1 to 9.
 - **toBytes()** generates KB MB GB etc.
 - **hex()** generates hexadecimal output with leading zeros up to **uint64_t**.
 - **bin()** generates binary output with leading zeros up to **uint64_t**.

diff --git a/examples/print64/print64.ino b/examples/print64/print64.ino
@@ -2,11 +2,12 @@
 //    FILE: print64.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo print 64 bit integers
-//    DATE: 2020-06-24
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
 
+
 uint64_t llx = 1311768467284833366;
 int64_t  lly = 0xFFFFFFFFFFFFFFFF;
 uint64_t a = 0;
@@ -57,5 +58,5 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 
diff --git a/examples/print_comma_separated_integers/print_comma_separated_integers.ino b/examples/print_comma_separated_integers/print_comma_separated_integers.ino
@@ -1,13 +1,13 @@
+//
 //    FILE: print_comma_separated_integers.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.0
-//    DATE: 2023-12-20
 // PURPOSE: demo readability
 //     URL: https://github.com/RobTillaart/printHelpers
 
-#include "Arduino.h"
+
 #include "printHelpers.h"
 
+
 void setup()
 {
   Serial.begin(115200);

diff --git a/examples/print_hex_bin/print_hex_bin.ino b/examples/print_hex_bin/print_hex_bin.ino
@@ -2,12 +2,15 @@
 //    FILE: print_hex_bin.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo hex(value, sep);
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
 
+
 volatile uint32_t n = 0;
 
+
 void setup()
 {
   Serial.begin(115200);
@@ -65,10 +68,6 @@ void setup()
   }
   Serial.println();
 
-
-
-
-
   Serial.println("10 random() BIN values");
   for (uint8_t i = 0; i < 10; i++)
   {
@@ -90,4 +89,4 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
diff --git a/examples/print_inch_feet/print_inch_feet.ino b/examples/print_inch_feet/print_inch_feet.ino
@@ -1,6 +1,8 @@
+//
 //    FILE: print_inch_feet.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo program distance functions
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"

diff --git a/examples/print_performance/print_performance.ino b/examples/print_performance/print_performance.ino
@@ -1,14 +1,18 @@
+//
 //    FILE: print_sci_eng_performance.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo program SCI
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
 
+
 uint32_t start = 0;
 uint32_t stop = 0;
 char * b;
 
+
 void setup()
 {
   Serial.begin(115200);
@@ -221,4 +225,4 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
diff --git a/examples/print_sci/print_sci.ino b/examples/print_sci/print_sci.ino
@@ -1,6 +1,8 @@
+//
 //    FILE: print_sci.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo program SCI
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"

diff --git a/examples/print_sci_experimental/print_sci_experimental.ino b/examples/print_sci_experimental/print_sci_experimental.ino
@@ -1,12 +1,15 @@
+//
 //    FILE: print_sci_experimental.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: test program SCI
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
 
 uint32_t start, stop, duration;
 
+
 void setup()
 {
   Serial.begin(115200);

diff --git a/examples/print_toRoman/print_toRoman.ino b/examples/print_toRoman/print_toRoman.ino
@@ -1,12 +1,15 @@
+//
 //    FILE: print_toRoman.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo program toRoman
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
 
 uint32_t start, stop;
 
+
 void setup()
 {
   Serial.begin(115200);

diff --git a/examples/sci_test/sci_test.ino b/examples/sci_test/sci_test.ino
@@ -2,6 +2,7 @@
 //    FILE: sci_test.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: test different values with sci function
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
@@ -197,5 +198,5 @@ void test6()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 
diff --git a/examples/toBytes/toBytes.ino b/examples/toBytes/toBytes.ino
@@ -2,6 +2,7 @@
 //    FILE: toBytes.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo toBytes(double val);
+//     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "printHelpers.h"
@@ -55,4 +56,4 @@ void loop()
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
diff --git a/library.json b/library.json
@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/printHelpers"
   },
-  "version": "0.4.3",
+  "version": "0.4.4",
   "license": "MIT",
   "frameworks": "*",
   "platforms": "*",

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=printHelpers
-version=0.4.3
+version=0.4.4
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Arduino library to help formatting data for printing. 64 bit integers (base 10 and 16). Engineering and scientific notation.

diff --git a/printHelpers.cpp b/printHelpers.cpp
@@ -2,8 +2,8 @@
 //    FILE: printHelpers.cpp
 //  AUTHOR: Rob Tillaart
 //    DATE: 2018-01-21
-// VERSION: 0.4.3
-// PUPROSE: Arduino library to help formatting for printing.
+// VERSION: 0.4.4
+// PURPOSE: Arduino library to help formatting for printing.
 //     URL: https://github.com/RobTillaart/printHelpers
 
 

diff --git a/printHelpers.h b/printHelpers.h
@@ -3,16 +3,16 @@
 //    FILE: printHelpers.h
 //  AUTHOR: Rob Tillaart
 //    DATE: 2018-01-21
-// VERSION: 0.4.3
-// PUPROSE: Arduino library to help formatting for printing.
+// VERSION: 0.4.4
+// PURPOSE: Arduino library to help formatting for printing.
 //     URL: https://github.com/RobTillaart/printHelpers
 
 
 #include "Arduino.h"
 #include "stdlib.h"
 
 
-#define PRINTHELPERS_VERSION      (F("0.4.3"))
+#define PRINTHELPERS_VERSION      (F("0.4.4"))
 
 
 //  global buffer used by all functions so no static buffer in every function