Merge pull request #14 from M1nd3r/UTest

Documentation update

Author: M1nd3r

FolderSync/InputHandler.cs

@@ -2,7 +2,7 @@
 
 namespace FolderSync {
     public static class InputHandler {
-        private const string MSG_SYNTAX = "Syntax is: \"From\" \"To\" \"SyncIntervalSeconds\" \"logFile\"\n\nExample: C:\\sourceFolder\\ C:\\targetFolder\\ 300 C:\\logfile.txt\n\nSyncIntervalSeconds and logFile are optional arguments. It is possible to add one or both. If both optional arguments are entered, the order must be preserved.";
+        private const string MSG_SYNTAX = "Syntax is: \"From\" \"To\" \"SyncIntervalSeconds\" \"LogFile\"\n\nExample: C:\\sourceFolder\\ C:\\targetFolder\\ 300 C:\\logfile.txt\n\nSyncIntervalSeconds and logFile are optional arguments. It is possible to add one or both. If both optional arguments are entered, the order must be preserved.";
         private static string? fromPath, toPath;
         private static int intervalSeconds = -1;
         public static int IntervalSeconds { get => intervalSeconds; }
@@ -40,8 +40,10 @@ private static bool HandleMandatoryArguments(string[] args) {
             return HandleToFolder(args[1]);
         }
         private static bool HandleFourArguments(string[] args) {
-            if (!IsInterval(args[2]))
+            if (!IsInterval(args[2])) {
+                Console.WriteLine("Invalid SyncIntervalSeconds argument.");
                 return false;
+            }
             AssignInterval(args[2]);
             return HandleLogFile(args[3]);
         }

README.md

@@ -1,2 +1,19 @@
 # FolderSync
- C# Console application for one-way folder sync
+ C# Console application for one-way folder sync.
+
+## Arguments
+The application takes 4 arguments, 2 mandatory (**From**, **To**) and 2 optional (**SyncIntervalSeconds**, **LogFile** ).
+- **From** - path of source folder
+- **To** - path of target folder
+- **SyncIntervalSeconds** - time interval between two consecutive synchronizations. Value less then 1 will result in a one-time synchronization without repetition.
+- **LogFile** - a path to a file where text log will be saved. If log file already exists, new log will be appended. If the file does not exist, app will try to create it. Note that if app is terminated forcefully, parts of log from session might be lost.
+
+## Syntax
+There are 4 allowed ways (orders) to pass arguments:
+- **From** **To**
+- **From** **To** **SyncIntervalSeconds**
+- **From** **To** **LogFile**
+- **From** **To** **SyncIntervalSeconds** **LogFile**
+
+## Author
+Created by Petr Sedláček in 2023.