Merge pull request #3 from tip2tail/issue-1-byte-count-alignment

Fix alignment issue #1

Author: tip2tail

.vscode/launch.json

@@ -5,7 +5,24 @@
    "version": "0.2.0",
    "configurations": [
         {
-            "name": ".NET Core Launch (console)",
+            "name": "Debug Run | Program.cs -s 100 -c 150",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder}/bin/Debug/netcoreapp3.1/HexPrintFile.dll",
+            "args": [
+                "${workspaceFolder}/Program.cs",
+                "-s 100",
+                "-c 150"
+            ],
+            "cwd": "${workspaceFolder}",
+            // For more information about the 'console' field, see https://aka.ms/VSCode-CS-LaunchJson-Console
+            "console": "internalConsole",
+            "stopAtEntry": false
+        },
+        {
+            "name": "Debug Run | -help",
             "type": "coreclr",
             "request": "launch",
             "preLaunchTask": "build",

CHANGES.md

@@ -0,0 +1,24 @@
+# HexPrintFile Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.1] - 2020-05-24
+
+### Added
+- This changelog document.
+
+### Changed
+- Fixed alignment of the byte count headings.
+
+## 1.0.0 - 2020-05-22
+
+### Added
+- Initial release
+
+[unreleased]: https://github.com/tip2tail/HexPrintFile/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/tip2tail/HexPrintFile/compare/v1.0.0...v1.0.1

HexPrintFile.csproj

@@ -7,7 +7,7 @@
 
     <!-- Deterministic needs to be false for the build date functionality to work -->
     <Deterministic>false</Deterministic>
-    <AssemblyVersion>1.0.0</AssemblyVersion>
+    <AssemblyVersion>1.0.1</AssemblyVersion>
 
   </PropertyGroup>
 

Program.cs

@@ -252,7 +252,7 @@ private static bool ExecuteHexPrint(string fileName,
                 : "Note: Strings are all ZERO INDEXED");
             Console.WriteLine("");
 
-            OutputHeader(mainImage, zeroImage);
+            OutputHeader(ref mainImage, zeroImage);
 
             try
             {
@@ -316,17 +316,21 @@ private static bool ExecuteHexPrint(string fileName,
                 return false;
             }
 
-            OutputHeader(mainImage, zeroImage);
+            OutputHeader(ref mainImage, zeroImage);
             return true;
         }
 
         /// <summary>
         /// Outputs the header for the HEX print
         /// </summary>
-        /// <param name="mainImage">Main byte range image</param>
+        /// <param name="mainImage" ref="true">Main byte range image</param>
         /// <param name="zeroImage">Zero count byte range image</param>
-        private static void OutputHeader(string mainImage, string zeroImage)
+        private static void OutputHeader(ref string mainImage, string zeroImage)
         {
+            // Main heading minimum = 14
+            if (mainImage.Length < 5) {
+                mainImage = "00000";
+            }
             var mainLen = ((2 * mainImage.Length) + 4) + 1;
             var mainHeading = "ACTUAL BYTES";
             while (mainHeading.Length < mainLen) {

README.md

@@ -29,6 +29,10 @@
 </p>
 
 <!-- ABOUT THE PROJECT -->
+## Changelog
+
+View the changes to this project: [Changelog](./CHANGES.md).
+
 ## Screenshot
 
 <img src="screen.png" alt="Screenshot">
@@ -105,7 +109,22 @@ Contributions are what make the open source community such an amazing place to b
 4. Push to the Branch (`git push origin feature/AmazingFeature`)
 5. Open a Pull Request
 
+## Build Release Version
+
+To build a release version use the following commands.
 
+- Windows
+````
+dotnet publish -c Release --self-contained -r win-x64 /p:PublishSingleFile=true
+````
+- Linux
+````
+dotnet publish -c Release --self-contained -r linux-x64 /p:PublishSingleFile=true
+````
+- macOS
+````
+dotnet publish -c Release --self-contained -r osx-x64 /p:PublishSingleFile=true
+````
 
 <!-- LICENSE -->
 ## License