Clarified library dependencies; added Markdown documentation to projects

This commit is contained in:
Markus Ewald 2024-06-18 19:06:01 +02:00
parent 01965038df
commit ac82e2f1f6
2 changed files with 12 additions and 5 deletions

View File

@ -1,5 +1,5 @@
Nuclex.Support Dependencies Nuclex.Windows.Forms Dependencies
=================================== ================================
To Compile the Library To Compile the Library
@ -10,18 +10,20 @@ the following directory layout:
root/ root/
Nuclex.Windows.Forms/ <-- you are here Nuclex.Windows.Forms/ <-- you are here
Nuclex.Windows.Forms (net-4.6).csproj ...
Nuclex.Support.Native/ <-- Git: nuclex-shared-dotnet/Nuclex.Support Nuclex.Support.Native/ <-- Git: nuclex-shared-dotnet/Nuclex.Support
Nuclex.Support (net-4.6).csproj ...
third-party/ third-party/
nunit nunit
nmock nmock
You should already have that directory layout in playe if you cloned the "frame fixer" You should already have that directory layout in place if you cloned the "foundation package"
repository (with `--recurse-submodules`). repository (with `--recurse-submodules`).
The actual, direct requirements of the code to compile are:
* Nuclex.Support * Nuclex.Support
* nunit (optional, if unit tests are built) * nunit (optional, if unit tests are built)
* nmock (optional, if unit tests are built) * nmock (optional, if unit tests are built)
@ -30,4 +32,5 @@ repository (with `--recurse-submodules`).
To Use this Library as a Binary To Use this Library as a Binary
------------------------------- -------------------------------
* Nuclex.Windows.Forms.dll
* Nuclex.Support.dll * Nuclex.Support.dll

View File

@ -159,7 +159,11 @@
<None Include="..\Foundation.snk"> <None Include="..\Foundation.snk">
<Link>Foundation.snk</Link> <Link>Foundation.snk</Link>
</None> </None>
<None Include="Dependencies.md" />
<None Include="License.md" />
<None Include="Notice.md" />
<None Include="packages.config" /> <None Include="packages.config" />
<None Include="ReadMe.md" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<Folder Include="Resources\" /> <Folder Include="Resources\" />