Update: Better documentation of redub features

Author: MrcSnm

README.md

@@ -1,51 +1,50 @@
 # Redub - Dub Based Build System
 [![Update release and nightly](https://github.com/MrcSnm/redub/actions/workflows/ci.yml/badge.svg)](https://github.com/MrcSnm/redub/actions/workflows/ci.yml)
 
-
-## Running redub without having it on path
+## Redub for dub users
 - Change directory to the project you want to build and enter in terminal `dub run redub`
-- You may also get help by running `dub run redub -- --help`
-- If you're unsure on how to update redub to the latest version using dub, you may also do `dub run redub -- update`
+  > To fully take advantage of redub speed, you might as well use redub directly.
 
 ## Building redub
-- Enter in terminal and execute `dub`
+- Enter in terminal and execute [`dub`](https://github.com/dlang/dub)
 - Highly recommended that you build it with `dub build -b release-debug --compiler=ldc2` since this will also improve its speed on dependency resolution
-- I would also add redub/bin to the environment variables, with that, you'll be able to simply execute `redub` in the folder you're in and get your project built and running
-- After having your first redub version, you may also update redub by entering on terminal `redub update`. This will download the latest version, rebuild redub with optimizations and replace your current redub executable
 
-## Using its library API
 
-The usage of the library APIispretty straightforward. You get mainly 2 functions
-1. `resolveDependencies` which will parse the project and its dependencies, after that, you got all the project information
-2. `buildProject` which will get the project information and build in parallel
+# Redub Additions
+Those are the additions I've made over dub
+- Self Update: `redub update` will either sync to the latest repo (and build it) or replace it with latest release
+- [Compiler Management](#compiler-management) - Support to change default compiler and install on command line
+- [Redub Plugins](#redub-plugins) - Alternative to rdmd. Execute arbitrary D code in the build steps.
+- [Multi Language](#multi-language) - Compile a C project together and include it on the linking step
+- [Library API](#using-its-library-api) - Integrate redub directly in your application
+- Watching Directories - `redub watch`- Builds dependents automatically on changes. Add  `--run` to run the program after building.
+- MacOS Universal Builds - `redub build-universal` - Generates a single binary containing arm64 and x86_64 architectures on MacOS
 
-```d
-import redub.api;
-import redub.logging;
 
-void main()
-{
-  import std.file;
-  //Enables logging on redub
-  setLogLevel(LogLevel.verbose);
+## Redub Help
+- [Original Dub Documentation](https://dub.pm/)
+- You may also get help by running `dub run redub -- --help` or simply `redub --help`
 
-  //Gets the project information
-  ProjectDetails d = resolveDependencies(
-    invalidateCache: false,
-    std.system.os,
-    CompilationDetails("dmd", "arch not yet implemented", "dmd v[2.105.0]"),
-    ProjectToParse("configuration", getcwd(), "subPackage", "path/to/dub/recipe.json (optional)")
-  );
 
-  /** Optionally, you can change some project information by accessing the details.tree (a ProjectNode), from there, you can freely modify the BuildRequirements of the project
-  * d.tree.requirements.cfg.outputDirectory = "some/path";
-  * d.tree.requirements.cfg.dFlags~= "-gc";
-  */
 
-  //Execute the build process
-  buildProject(d);
-}
-```
+## Compiler Management
+- Installing new compilers, use `redub install`:
+  ```
+  redub install requires 1 additional argument:
+          opend: installs opend
+          ldc <version?|help>: installs ldc latest if version is unspecified.
+                  help: Lists available ldc versions
+          dmd <version?>: installs the dmd with the version 2.111.0 if version is unspecified
+  ```
+- Using the new compilers, use `redub use` - Redub use will also install if you don't already have it:
+  ```
+  redub use requires 1 additional argument:
+        opend <dmd|ldc>: uses the wanted opend compiler as the default
+        ldc <version?>: uses the latest ldc latest if version is unspecified.
+        dmd <version?>: uses the 2.111.0 dmd if the version is unspecified.
+        reset: removes the default compiler and redub will set it again by the first one found in the PATH environment variable
+  ```
+
 
 ## Redub Plugins
 
@@ -82,7 +81,7 @@ For using it on prebuild, you simply specify the module and its arguments:
 }
 ```
 
-### Useful links regarding plugins:
+**Useful links regarding plugins:**
 - [**GetModule plugin**](./plugins/getmodules/source/getmodules.d)
 - [**Example Usage**](./tests/plugin_test/dub.json)
 
@@ -95,6 +94,41 @@ Redub has also an experimental support for building and linking C/C++ code toget
 }
 ```
 
+## Using its library API
+
+The usage of the library APIispretty straightforward. You get mainly 2 functions
+1. `resolveDependencies` which will parse the project and its dependencies, after that, you got all the project information
+2. `buildProject` which will get the project information and build in parallel
+
+```d
+import redub.api;
+import redub.logging;
+
+void main()
+{
+  import std.file;
+  //Enables logging on redub
+  setLogLevel(LogLevel.verbose);
+
+  //Gets the project information
+  ProjectDetails d = resolveDependencies(
+    invalidateCache: false,
+    std.system.os,
+    CompilationDetails("dmd", "arch not yet implemented", "dmd v[2.105.0]"),
+    ProjectToParse("configuration", getcwd(), "subPackage", "path/to/dub/recipe.json (optional)")
+  );
+
+  /** Optionally, you can change some project information by accessing the details.tree (a ProjectNode), from there, you can freely modify the BuildRequirements of the project
+  * d.tree.requirements.cfg.outputDirectory = "some/path";
+  * d.tree.requirements.cfg.dFlags~= "-gc";
+  */
+
+  //Execute the build process
+  buildProject(d);
+}
+```
+
+
 With that, you'll be able to specify that your dependency is a C/C++ dependency. then, you'll be able to build it by calling `redub --cc=gcc`. You can also
 specify both D and C at the same time `redub --cc=gcc --dc=dmd`. Which will use DMD to build D and GCC to C.