Updating documentations

Author: Neko-Box-Coder

README.md

@@ -28,48 +28,17 @@ you can run c++ files anywhere you want.
 
 ## ⚡️ Getting Started
 
-### 1. Running source file directly
-Suppose you have a c++ file called `script.cpp`, you can run it immediately by doing 
+### Interactive Tutorial
 
-> *shell*
-```shell
-runcpp2 ./script.cpp <any arguments>
-```
+You can get started by running the tutorial with `runcpp2 --tutorial` and follow the instructions
 
-> [!NOTE]
-> On Unix, if you have added runcpp2 to your PATH and add this line `//bin/true;runcpp2 "$0" "$@"; exit $?;` 
-> to the top of your script, you can run the script directly by `./script.cpp <arguments>`
+### User Guide
 
----
+You can also follow the documentation guide on 
+[https://neko-box-coder.github.io/runcpp2/latest/guides/basics/](https://neko-box-coder.github.io/runcpp2/latest/guides/basics/)
 
-### 2. Watch and give compile errors
-If you want to edit the script but want to have feedback for any error, you can use "watch" mode.
+### Examples
 
-> *shell*
-```shell
-runcpp2 --watch ./script.cpp
-```
-
----
-
-### 3. Sepcifying Build Settings
-Build settings such as compile/link flags, external dependencies, command hooks, etc.
-can be spcified inlined inside a source file or as a separate yaml file in the format of YAML
-
-- To specify build settings in a dedicated yaml file:
-    - The yaml file in the same directory and share the same as the source file being run will be used
-- To specify inline build settings inside a source file: 
-    - Put them inside a comment with `runcpp2` at the beginning of the build settings
-    - The inline build settings can exist in anywhere of the source file
-    - Both inline (but continuous) comments (`//`) and block comments are supported (`/* */`)
-
-For a complete list of build settings, see [Build Settings](https://neko-box-coder.github.io/runcpp2/latest/build_settings/) or generate the template with
-
-> *shell*
-```shell
-runcpp2 --create-script-template ./script.cpp   # Embeds the build settings template as comment
-runcpp2 --create-script-template ./script.yaml  # Creates the build settings template as dedicated yaml file
-runcpp2 -t ./script.cpp                         # Short form
-```
+You can find all the examples you can run out of the box in [https://github.com/Neko-Box-Coder/runcpp2/tree/master/Examples](https://github.com/Neko-Box-Coder/runcpp2/tree/master/Examples)
 
 

mkdocs/docs/TODO.md

@@ -1,46 +1,48 @@
 # Roadmap
 
+
 ## Done
 
-!!! info "`latest` version"
-    - More git options
-        - Add branch/tag option for git
-        - Add initialize submodule option for git
-    - Async/Multi-thread compile and dependencies processing
-    - Ability to skip DefaultPlatform and DefaultProfile
-    - Handle escape characters at the end
-        - To avoid situation like this:
-            - Substitution string: `-I "{path}"`
-            - Substitution value: `.\`
-            - Substituted string: `-I ".\"`
-                - Where the path contains escape character which escaped the wrapping quotes
-    - Add platform map for PreferredProfile for user config
-    - Add ability to reference local YAML file for config profiles
+### v0.3.0
+- More git options
+    - Add branch/tag option for git
+    - Add initialize submodule option for git
+- Async/Multi-thread compile and dependencies processing
+- Ability to skip DefaultPlatform and DefaultProfile
+- Handle escape characters at the end
+    - To avoid situation like this:
+        - Substitution string: `-I "{path}"`
+        - Substitution value: `.\`
+        - Substituted string: `-I ".\"`
+            - Where the path contains escape character which escaped the wrapping quotes
+- Add platform map for PreferredProfile for user config
+- Add ability to reference local YAML file for config profiles
+- Add interactive tutorials and redo documentations
+
+### Nightly
 
 ## Planned
 
-### v0.3.0
-- Add interactive tutorials and redo documentations
+### v0.4.0
 
 - Allow runcpp2 to be library for scriptable pipeline
 - Add version for default user config and prompt for update
 - Add more default profiles
-
-### v0.4.0
-
 - Migrate to libyaml
 - Ability to compile runcpp2 as single cpp
 
-### TBD
+## High Priority
 
+- Update `FileProperties.hpp` to use list of string for prefix and extension
+    - Merge `SharedLinkFile` and `SharedLibraryFile`
 - Add the ability for user to specify custom substitution options which applies to all fields
 - Add the ability to append defines coming from the dependencies
-- Check last run is shared lib or executable. Reset cache when necessary if different type
+- Check last run is shared lib or executable. Reset cache when necessary if different type (`Src/runcpp2/CompilingLinking.cpp:502 LinkScript()`)
 - Add wildcard support for filenames and extensions (Files Globbing)
 - Add the ability to query script build directory
 - Add the ability to list script dependencies
 
-## Planned But Low Priority
+## TBD
 
 - Smoother CMake support by reading cmake target properties (https://stackoverflow.com/a/56738858/23479578)
 <!--
@@ -82,7 +84,7 @@ endfunction()
 print_target_properties(matplot)
 -->
 - Add the ability to specify different profiles(?)/defines for different source files
-- Use <csignal> to handle potential segfaults
+- Use `<csignal>` to handle potential segfaults
 - Use System2 subprocess if no prepend commands to be safer
 - Add tests and examples (On Windows as well)
 - Make SearchLibraryNames and SearchDirectories optional (?)