Update 'README.md'

OWTrack/OWTrack.csproj

@@ -112,6 +112,7 @@
     <Compile Include="MainForm.Designer.cs">
       <DependentUpon>MainForm.cs</DependentUpon>
     </Compile>
+    <Compile Include="Paths.cs" />
     <Compile Include="saveManeger.cs" />
     <Compile Include="Tracker.cs" />
     <Compile Include="Program.cs" />

OWTrack/Paths.cs

@@ -0,0 +1,67 @@
+/*Copyright(c) 2018 Hesham Systems LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.*/
+
+using System.IO;
+
+namespace OWTrack
+{
+    public struct Paths
+    {
+        /// <summary>
+        /// Current Application directory.
+        /// </summary>
+        private static string curDir = Directory.GetCurrentDirectory();
+
+        /// <summary>
+        /// Saves Folder relative path. \n Relative to Application Directory. 
+        /// </summary>
+        private static string SAVES = curDir + "/saves/data.json";
+
+        /// <summary>
+        /// Saves Folder relative path. \n Relative to Application Directory. 
+        /// </summary>
+        private static string JSON = curDir + "/data.json";
+
+        public static string GetJSON() { return JSON; }//TODO: Unused var
+
+        /// <summary>
+        /// Get Saves file Path.
+        /// </summary>
+        /// <returns></returns>
+        public static string GetSaves() { return SAVES; }
+
+        /// <summary>
+        /// Get Current Application directory.
+        /// </summary>
+        /// <returns></returns>
+        public static string GetCurrentDir() { return curDir; }
+
+        /// <summary>
+        /// "Program Files" standered constant paths. 
+        /// </summary>
+        public struct ProgramFiles
+        {
+            public const string C = "C:\\Program Files";
+            public const string D = "D:\\Program Files";
+            public const string E = "E:\\Program Files";
+            public const string F = "F:\\Program Files";
+        }
+    }
+}

OWTrack/Program.cs

@@ -17,6 +17,6 @@ namespace OWTrack
             Application.SetCompatibleTextRenderingDefault(false);
             Application.Run(new MainForm());
         }
-        public static string Version { get; } = "1.4.3";       
+        public static string Version { get; } = "1.4.4.a1";       
     }
 }

OWTrack/Tracker.cs

@@ -22,13 +22,13 @@ using System;
 using System.Diagnostics;
 using System.Linq;
 using System.IO;
-using System.Windows.Forms;
 using System.Collections.Generic;
 
 namespace OWTrack
 {
     class Tracker
     {
+        //TODO: Encapsulate
         public int wins, losses, startSR, newSR, totalMatches = 0;
         
         public void addWin() => wins++;
@@ -88,10 +88,9 @@ namespace OWTrack
                                     .FirstOrDefault(p => p.MainModule.FileName.StartsWith(settings.GamePath)) != default(Process);
                     return isRunning;
                 }
-                catch (Exception)
+                catch (Exception e)
                 {                    
-                    Exception ex = new Exception("Error");
-                    throw ex;
+                    throw e;
                 }
             }
             else return false;
@@ -126,9 +125,8 @@ namespace OWTrack
                 }
                 else return false;
             }
-            catch (Exception e)
+            catch (Exception)
             {
-                MessageBox.Show(e.Message);
                 return false;
             }
         }

OWTrack/saveManeger.cs

@@ -24,40 +24,21 @@ using System.IO;
 
 namespace OWTrack
 {
-    public struct Paths
-    {
-        private static string curDir = Directory.GetCurrentDirectory();
-        private static string SAVES = curDir + "/saves/data.json";
-        private static string JSON = curDir + "/data.json";
-        public static string GetJSON() { return JSON; }
-        public static string GetSaves() { return SAVES; }
-        public static string GetCurrentDir() { return curDir; }
-
-        public struct ProgramFiles
-        {
-            public const string C = "C:\\Program Files";
-            public const string D = "D:\\Program Files";
-            public const string E = "E:\\Program Files";
-            public const string F = "F:\\Program Files";
-        }
-    }
-
     class saveManeger
     {
         /// <summary>
         /// Deserialize saved tracker instance.
         /// </summary>
-        /// <returns></returns>
+        /// <returns>Tracker Object</returns>
         public static Tracker GetSavedTracker()
         {
             try
             {
                 return JsonConvert.DeserializeObject<Tracker>(File.ReadAllText(Paths.GetSaves()));
             }
-            catch (Exception)
+            catch (Exception e)
             {
-                Exception ex = new Exception("json");
-                throw ex;
+                throw e;
             }
         }
 
@@ -79,10 +60,10 @@ namespace OWTrack
         }
 
         /// <summary>
-        ///Saves the Tracker Object. 
+        /// Deserializes and Saves the Tracker Object. 
         /// </summary>
         /// <param name="tracker"></param>
-        /// <returns></returns>
+        /// <returns>Boolean value that represents the success or failuer</returns>
         public static bool SaveJSON(Tracker tracker)
         {
             try

README.md

@@ -1,4 +1,4 @@
-# OWtrack ![CI status](https://img.shields.io/badge/build-passing-brightgreen.svg) [![GitHub](https://img.shields.io/badge/Version-1.4.3-blue.svg)] (https://heshamgit.ddns.net/Hesham/OWtrack/releases) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT)
+# OWtrack ![CI status](https://img.shields.io/badge/build-passing-brightgreen.svg) [![GitHub](https://img.shields.io/badge/Version-1.4.3-blue.svg)](https://apollo-server.ddns.net/gitea/Hesham/OWtrack/releases) [![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT)
 
  Track your Overwatch preformance with a shi#ty UI