Add README files for two libraries

CHANGELIST.md

@@ -103,6 +103,7 @@
 - Fix important typo
 - Remove vestigial configuration file
 - Remove reference to removed file
+- Add README files for two libraries
 
 ### 3.2.4 (2024-11-24)
 

MPF.ExecutionContexts/MPF.ExecutionContexts.csproj

@@ -23,6 +23,10 @@
         <RepositoryType>git</RepositoryType>
     </PropertyGroup>
 
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="" />
+    </ItemGroup>
+
     <ItemGroup>
         <InternalsVisibleTo Include="MPF.ExecutionContexts.Test" />
     </ItemGroup>

MPF.ExecutionContexts/README.md

@@ -0,0 +1,13 @@
+# MPF.ExecutionContexts
+
+This library represents the logic needed to invoke 3 different dumping programs:
+
+- [Aaru](github.com/aaru-dps/Aaru)
+- [DiscImageCreator](github.com/saramibreak/DiscImageCreator)
+- [Redumper](https://github.com/superg/redumper)
+
+These execution wrappers allow for generating valid parameters for each of the programs as well as provide some helpers that make it easier to determine what those parameters are.
+
+External options are defined in order to help create reasonable default parameter sets for different combinations of media type and system.
+
+Paths to the programs need to be provided if they are expected to be invoked as a part of another program. The expected versions of these programs can be found in either the changelog or the publish script in the parent project.

MPF.Processors/MPF.Processors.csproj

@@ -28,6 +28,10 @@
         <InternalsVisibleTo Include="MPF.Processors.Test" />
     </ItemGroup>
 
+    <ItemGroup>
+        <None Include="README.md" Pack="true" PackagePath="" />
+    </ItemGroup>
+
     <!-- Support for old .NET versions -->
     <ItemGroup Condition="!$(TargetFramework.StartsWith(`net2`)) AND !$(TargetFramework.StartsWith(`net3`)) AND !$(TargetFramework.StartsWith(`net40`))">
         <PackageReference Include="System.IO.Compression" Version="4.3.0" />

MPF.Processors/README.md

@@ -0,0 +1,19 @@
+# MPF.Processors
+
+This library represents the logic needed to process the outputs of 7 different dumping programs:
+
+- [Aaru](github.com/aaru-dps/Aaru)
+- [CleanRip](https://github.com/emukidid/cleanrip)
+- [DiscImageCreator](github.com/saramibreak/DiscImageCreator)
+- PS3 Custom Firmware (CFW)
+- [Redumper](https://github.com/superg/redumper)
+- [UmdImageCreator](https://github.com/saramibreak/UmdImageCreator)
+- Xbox Backup Creator (XBC)
+
+These processors allow for extracting a large amount of information from the output files generated by each of the programs. This information is then formatted according to the requirements of [Redump](http://redump.org/), which provides an easy comparison point.
+
+Each processor also includes the ability to clean up the output files, including compressing certain types of output or deleting files that are not required to use the resulting images.
+
+There is no requirement that the original media is present for any of the processing to be done, though additional checks may be made if the media is present and made available to the library.
+
+Additionally, there is a specialized tool included that allows for information extraction from potentially generic sources. This tool is used across many of the processors and can be invoked separately by any calling library.