Added information about log file formatting to README.htm

endkb · Oct 16, 2024 · 9106b3b · 9106b3b
1 parent 8395a85
commit 9106b3b
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/README.htm b/README.htm
@@ -35,7 +35,7 @@
 	</head>
 	<body>
 		<h1>SoundsDownloadScript.ps1 + genRSS.ps1</h1>
-		<p><i>*Updated: 13-Oct-2024 22:30 GMT</i></p>
+		<p><i>*Updated: 16-Oct-2024 23:19 GMT</i></p>
 		<p>These instructions are very crude and messy. Sorry for the windbag word vomit. I hope they help, though. If someone wants to convert this file into a markdown README.md for github, be my guest. The scripts are a little tedious to set up the first time, but once you get them working they're pretty reliable.</p>
 		<p>I recommend you check the <a href="https://github.com/endkb/SoundsDownloadScript">repo on github</a> for the <a href="https://raw.githack.com/endkb/SoundsDownloadScript/main/README.htm">latest version of this README</a> before continuing.</p>
 		<p>If you find a bug in the scripts or something is incorrect or incomplete in the documentation, feel free to <a href="https://github.com/endkb/SoundsDownloadScript/issues">open an issue on github</a>.</p>
@@ -105,7 +105,7 @@ <h3 id="Installation_1">SoundsDownloadScript.ps1</h3>
 			<li>Unpack kid3 to a directory (recommend a subdirectory inside the directory  SoundsDownloadScript.ps1 is in).</li>
 			<li>Copy yt-dlp.exe to a directory (recommend inside the directory SoundsDownloadScript.ps1 is in).</li>
 			<li>If using rclone, unpack rclone to a directory (recommend a subdirectory inside the directory SoundsDownloadScript.ps1 is in).</li>
-			<li>If using OpenVPN, install it using the default options (should be everything except OpenSSL Utilities). Information and support can be found <a href="https://openvpn.net/community-resources/installing-openvpn/">on OpenVPN's website</a>. Note: This must be the Community edition, not OpenVPN Connect.</li>
+			<li>If using OpenVPN, install it using the default options (should be everything except OpenSSL Utilities). Information and support can be found on <a href="https://openvpn.net/community-resources/installing-openvpn/">OpenVPN's website</a>. Note: This must be the Community edition, not OpenVPN Connect.</li>
 			<li>Edit SoundsDownloadScript.ps1 before using and set the following variables:
 				<ul>
 					<li><code>$DefaultTrackNoFormat</code>: [<i>String</i>] DateTime formatted string (<a href="https://www.sharepointdiary.com/2021/11/date-format-in-powershell.html">see this guide for DateTime formatting help</a>) to set the track number if the <code>-TrackNoFormat</code> parameter is not set. Setting this to <code>'c'</code> will count up the track number from the last episode, <code>'c(r)'</code> does the same but searches recursive directories. Note: The <code>'c'</code> option will call kid3 on each track in the directory to determine the next track number. This can be slow as the directory fills up with more and more audio files. If you're not using the <code>-Archive</code> parameter, consider using a DateTime format instead. Also, <code>o</code> can be included in a DateTime as a one digit year, and <code>jjj</code> can be included in a DateTime as a Julian date.</li>
@@ -152,7 +152,7 @@ <h3 id="Installation_1">SoundsDownloadScript.ps1</h3>
 							<li><code>{1}</code> = Hash of task scheduler GUID</li>
 							<li><code>{2}</code> = PID of the script that is running</li>
 							<li><code>{3}</code> = The type of log (Console+Vars, rclone, vpn)</li>
-							<li><code>{4}</code> = Current date and time</li>
+							<li><code>{4}</code> = Current date and time (must only include <a href="https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file">legal file name chars</a>; <code>{4:yyyyMMdd_HHmmss}</code> is a good format)</li>
 						</ul>
 					<br></li>
 
@@ -264,7 +264,7 @@ <h3 id="Installation_2">genRSS.ps1 (if using)</h3>
 							<li><code>{1}</code> = Hash of task scheduler GUID</li>
 							<li><code>{2}</code> = PID of the script that is running</li>
 							<li><code>{3}</code> = The type of log (Console+Vars, rclone)</li>
-							<li><code>{4}</code> = Current date and time</li>
+							<li><code>{4}</code> = Current date and time (must only include <a href="https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file">legal file name chars</a>; <code>{4:yyyyMMdd_HHmmss}</code> is a good format)</li>
 						</ul>
 						This can also be given as a command line parameter (<code>-LogFileNameFormat</code>) or globally as a configurable option in the script (<code>$LogFileNameFormat</code>), instead.
 				<br><br></ul>