Documentation: Improve README and fix descriptions of some libraries

Pagghiu · Pagghiu · commit 54fb28bc229a · 2024-07-05T20:34:40.000+02:00
diff --git a/Documentation/Libraries/Algorithms.md b/Documentation/Libraries/Algorithms.md
@@ -1,6 +1,6 @@
 @page library_algorithms Algorithms
 
-@brief 🟥 Placeholder library templated algorithms will be placed
+@brief 🟥 Placeholder library templated where algorithms will be placed
 
 [TOC]
 
diff --git a/Documentation/Libraries/FileSystem.md b/Documentation/Libraries/FileSystem.md
@@ -1,6 +1,6 @@
 @page library_file_system File System
 
-@brief 🟩 File System operations { exists | copy | delete } for { files | directories }
+@brief 🟩 File System operations { exists, copy, delete } for { files and directories }
 
 [TOC]
 
diff --git a/Documentation/Pages/Examples.md b/Documentation/Pages/Examples.md
@@ -25,11 +25,16 @@
 | Debug (VS2022)| Open `_Build/_Projects/VisualStudio2022/SCExample.sln` and start Debugging (F5)                                                   |
 
 https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/4ad12058-6bc2-4316-90f8-4ba4c05e28de
+https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/5c7d4036-6e0c-4262-ad57-9ef84c214717
 
 \htmlonly
 <iframe width="700" height="400" src="https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/4ad12058-6bc2-4316-90f8-4ba4c05e28de" frameborder="0" allowfullscreen>
 \endhtmlonly
 
+\htmlonly
+<iframe width="700" height="400" src="https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/5c7d4036-6e0c-4262-ad57-9ef84c214717" frameborder="0" allowfullscreen>
+\endhtmlonly
+
 # Where can I find more examples?
 
 - The test suite is the closest thing to additional examples you can find in this project.
diff --git a/Documentation/Pages/Platforms.md b/Documentation/Pages/Platforms.md
@@ -1,7 +1,7 @@
 @page page_platforms Platforms
 
 Supported:  
-✅ macOS (13.6 Ventura+ and iOS)  
+✅ macOS 13.6+ (Ventura) and iOS 14.0+
 ✅ Windows (10+)  
 ✅ Linux (Kernel 5.x+)
 
diff --git a/Libraries/Async/Async.h b/Libraries/Async/Async.h
@@ -282,7 +282,8 @@ namespace SC
 //! @{
 
 /// @brief Starts a Timeout that is invoked only once after expiration (relative) time has passed.
-/// @note For a peridic timeout, call AsyncLoopTimeout::Result::reactivateRequest(true) in the completion callback
+/// @note For a periodic timeout, call AsyncLoopTimeout::Result::reactivateRequest(true) in the completion callback
+///
 /// \snippet Libraries/Async/Tests/AsyncTest.cpp AsyncLoopTimeoutSnippet
 struct AsyncLoopTimeout : public AsyncRequest
 {
diff --git a/Libraries/FileSystem/FileSystem.h b/Libraries/FileSystem/FileSystem.h
@@ -17,7 +17,7 @@ struct StringConverter;
 //! @addtogroup group_file_system
 //! @{
 
-/// @brief Execute fs operations { exists | copy | delete } for { files | directories }.
+/// @brief Execute fs operations { exists, copy, delete } for { files and directories }.
 /// It will scope all operations on relative paths to the `initialWorkingDirectory` passed in SC::FileSystem::init.
 /// All methods can always return failure due to access or disk I/O errors, and they will be omitted in the return
 /// clauses for each method. Only the specific returned result behaviour of the given method will be described.
diff --git a/README.md b/README.md
@@ -28,12 +28,12 @@ Visit the [documentation website](https://pagghiu.github.io/SaneCppLibraries/ind
 
 Library                                                                                                 | Description
 :-------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------
-[Algorithms](https://pagghiu.github.io/SaneCppLibraries/library_algorithms.html)                        | 🟥 Placeholder library templated algorithms will be placed
+[Algorithms](https://pagghiu.github.io/SaneCppLibraries/library_algorithms.html)                        | 🟥 Placeholder library where templated algorithms will be placed
 [Async](https://pagghiu.github.io/SaneCppLibraries/library_async.html)                                  | 🟨 Async I/O (files, sockets, timers, processes, fs events, threads wake-up)
 [Build](https://pagghiu.github.io/SaneCppLibraries/library_build.html)                                  | 🟨 Minimal build system where builds are described in C++
 [Containers](https://pagghiu.github.io/SaneCppLibraries/library_containers.html)                        | 🟨 Generic containers (SC::Vector, SC::SmallVector, SC::Array etc.)
 [File](https://pagghiu.github.io/SaneCppLibraries/library_file.html)                                    | 🟩 Synchronous Disk File I/O
-[File System](https://pagghiu.github.io/SaneCppLibraries/library_file_system.html)                      | 🟩 File System operations { exists | copy | delete } for { files | directories }
+[File System](https://pagghiu.github.io/SaneCppLibraries/library_file_system.html)                      | 🟩 File System operations { exists, copy, delete } for { files and directories }
 [File System Iterator](https://pagghiu.github.io/SaneCppLibraries/library_file_system_iterator.html)    | 🟩 Enumerates files and directories inside a given path
 [File System Watcher](https://pagghiu.github.io/SaneCppLibraries/library_file_system_watcher.html)      | 🟩 Notifications {add, remove, rename, modified} for files and directories
 [Foundation](https://pagghiu.github.io/SaneCppLibraries/library_foundation.html)                        | 🟩 Primitive types, asserts, limits, Function, Span, Result, Tagged Union
@@ -90,8 +90,12 @@ Shortly:
 
 Check the [Examples](https://pagghiu.github.io/SaneCppLibraries/page_examples.html) page.
 
+## macOS
 https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/4ad12058-6bc2-4316-90f8-4ba4c05e28de
 
+## iOS
+https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/5c7d4036-6e0c-4262-ad57-9ef84c214717
+
 # Tests
 
 Tests are built with the self-hosted [SC::Build](https://pagghiu.github.io/SaneCppLibraries/library_build.html) project generator, describing the builds in C++.    
@@ -112,33 +116,41 @@ Alternatively I am also reading the following discords too:
 # Videos
 
 Blog posts:
-- [June 2024 Update](https://pagghiu.github.io/site/blog/2024-06-30-SaneCppLibrariesUpdate.html)
-- [May 2024 Update](https://pagghiu.github.io/site/blog/2024-05-31-SaneCppLibrariesUpdate.html)
-- [April 2024 Update](https://pagghiu.github.io/site/blog/2024-04-27-SaneCppLibrariesUpdate.html)
-- [March 2024 Update](https://pagghiu.github.io/site/blog/2024-03-27-SaneCppLibrariesUpdate.html)
-- [February 2024 Update](https://pagghiu.github.io/site/blog/2024-02-23-SaneCppLibrariesUpdate.html)
+
+You can find some [YouTube Videos](https://www.youtube.com/@Pagghiu) and [Blog posts](https://pagghiu.github.io) describing some bits of the development process:
+
+- [Ep.01 - Public Release](https://pagghiu.github.io/site/blog/2023-12-23-SaneCppLibrariesRelease.html)
+- [Ep.02 - Creating a Makefile](https://www.youtube.com/watch?v=2ccW8TBAWWE)
+- [Ep.03 - Add Makefile backend to SC::Build](https://www.youtube.com/watch?v=wYmT3xAzMxU)
+- [Ep.04 - Start Linux Porting](https://www.youtube.com/watch?v=DUZeu6VDGL8)
+- [Ep.05 - Build Everything on Linux](https://www.youtube.com/watch?v=gu3x3Y1zZLI)
+- [Ep.06 - Posix fork](https://www.youtube.com/watch?v=-OiVELMxL6Q)
+- [Ep.07 - SC::Async Linux epoll 1/2](https://www.youtube.com/watch?v=4rC4aKCD0V8)
+- [Ep.08 - SC::Async Linux epoll 2/2](https://www.youtube.com/watch?v=uCsGpJcF2oc)
+- [Ep.09 - SC::FileSystemWatcher Linux inotify implementation](https://www.youtube.com/watch?v=92saVDCRnCI)
 - [January 2024 Update](https://pagghiu.github.io/site/blog/2024-01-23-SaneCppLibrariesUpdate.html)
-- [Public Release blog post](https://pagghiu.github.io/site/blog/2023-12-23-SaneCppLibrariesRelease.html)
-
-On the [Youtube Channel](https://www.youtube.com/@Pagghiu) you can find some videos showing some bits of the development process:
-- [Creating a Makefile](https://www.youtube.com/watch?v=2ccW8TBAWWE)
-- [Add Makefile backend to SC::Build](https://www.youtube.com/watch?v=wYmT3xAzMxU)
-- [Start Linux Porting](https://www.youtube.com/watch?v=DUZeu6VDGL8)
-- [Build Everything on Linux](https://www.youtube.com/watch?v=gu3x3Y1zZLI)
-- [Posix fork](https://www.youtube.com/watch?v=-OiVELMxL6Q)
-- [SC::Async Linux epoll 1/2](https://www.youtube.com/watch?v=4rC4aKCD0V8)
-- [SC::Async Linux epoll 2/2](https://www.youtube.com/watch?v=uCsGpJcF2oc)
-- [SC::FileSystemWatcher Linux inotify implementation](https://www.youtube.com/watch?v=92saVDCRnCI)
-- [A Tour of SC::Async](https://www.youtube.com/watch?v=pIGosb2D2Ro)
-- [Linux Async I/O using io_uring (1 of 2)](https://www.youtube.com/watch?v=YR935rorb3E)
-- [Linux Async I/O using io_uring (2 of 2)](https://www.youtube.com/watch?v=CgYE0YrpHt0)
-- [Simple ThreadPool](https://www.youtube.com/watch?v=e48ruImESxI)
-- [Async file read and writes using Thread Pool](https://www.youtube.com/watch?v=WF9beKyEA_E)
-- [Implement SC::AsyncLoopWork](https://www.youtube.com/watch?v=huavEjzflHQ)
-- [BREAK SC::Async IO Event Loop](https://www.youtube.com/watch?v=3lbyx11qDxM)
-- [Pause Immediate Mode UI - Save CPU Time](https://www.youtube.com/watch?v=4acqdGcUQnE)
-- [Add Async IO to Immediate Mode GUI](https://www.youtube.com/watch?v=z7QaTa7drFo)
-- [Hot-Reload dear imgui](https://www.youtube.com/watch?v=BXybEWvSpGU)
+
+- [Ep.10 - A Tour of SC::Async](https://www.youtube.com/watch?v=pIGosb2D2Ro)
+- [Ep.11 - Linux Async I/O using io_uring (1 of 2)](https://www.youtube.com/watch?v=YR935rorb3E)
+- [Ep.12 - Linux Async I/O using io_uring (2 of 2)](https://www.youtube.com/watch?v=CgYE0YrpHt0)
+- [Ep.13 - Simple ThreadPool](https://www.youtube.com/watch?v=e48ruImESxI)
+- [February 2024 Update](https://pagghiu.github.io/site/blog/2024-02-23-SaneCppLibrariesUpdate.html)
+
+- [Ep.14 - Async file read and writes using Thread Pool](https://www.youtube.com/watch?v=WF9beKyEA_E)
+- [March 2024 Update](https://pagghiu.github.io/site/blog/2024-03-27-SaneCppLibrariesUpdate.html)
+
+- [Ep.16 - Implement SC::AsyncLoopWork](https://www.youtube.com/watch?v=huavEjzflHQ)
+- [April 2024 Update](https://pagghiu.github.io/site/blog/2024-04-27-SaneCppLibrariesUpdate.html)
+
+- [Ep.18 - BREAK SC::Async IO Event Loop](https://www.youtube.com/watch?v=3lbyx11qDxM)
+- [May 2024 Update](https://pagghiu.github.io/site/blog/2024-05-31-SaneCppLibrariesUpdate.html)
+
+- [Ep.20 - Pause Immediate Mode UI - Save CPU Time](https://www.youtube.com/watch?v=4acqdGcUQnE)
+- [Ep.21 - Add Async IO to Immediate Mode GUI](https://www.youtube.com/watch?v=z7QaTa7drFo)
+- [Ep.22 - Hot-Reload dear imgui](https://www.youtube.com/watch?v=BXybEWvSpGU)
+- [June 2024 Update](https://pagghiu.github.io/site/blog/2024-06-30-SaneCppLibrariesUpdate.html)
+
+- [Ep.24 - Hot-Reload C++ on iOS](https://www.youtube.com/watch?v=6DfykfYCQdY)
 
 
 # Contributing

Original file line number	Diff line number	Diff line change
`@@ -282,7 +282,8 @@ namespace SC`
`282`	`282`	`//! @{`
`283`	`283`
`284`	`284`	`/// @brief Starts a Timeout that is invoked only once after expiration (relative) time has passed.`
`285`		`-/// @note For a peridic timeout, call AsyncLoopTimeout::Result::reactivateRequest(true) in the completion callback`
	`285`	`+/// @note For a periodic timeout, call AsyncLoopTimeout::Result::reactivateRequest(true) in the completion callback`
	`286`	`+///`
`286`	`287`	`/// \snippet Libraries/Async/Tests/AsyncTest.cpp AsyncLoopTimeoutSnippet`
`287`	`288`	`struct AsyncLoopTimeout : public AsyncRequest`
`288`	`289`	`{`