When adding GeonBit.UI to an existing project, the NuGet does not include the GeonBit.UI.Examples directory as described in step 2 in the Via Nuget section of the README.md
Steps to reproduce
The following are the steps to reproduce in my use-case using Visual Studio Code and the terminal to create the project and add the NuGet package
dotnet new sln -n ExampleSolution
dotnet new mgdesktopgl -n ExampleProject
dotnet sln add ./ExampleProject
dotnet restore
cd ./ExampleProject
dotnet add package GeonBit.UI
The above steps create a ExampleSolution.sln file and an example MonoGame DesktopGL project called ExampleProject then adds that project to the solution. Then performs a dotnet restore. Next it changes into the ExampleProject directory and adds the GeonBit.UI NuGet package to the project.
Expected Result
Step 2 of the installation instructions states that the installation would place a folder in GeonBit.Ui.Examples\Content\GeonBit.UI.
Actual Result
By default, NuGet packages are downloaded to %USERPROFILE%\.nuget\packages\. The GeonBit.UI package is downloaded to
%USERPROFILE%\.nuget\packages\geonbit.ui as expected, but within the package there is no GeonBit.UI.Examples directory.
Additional Notes
Even understanding what the documentation is trying to say, it's still misleading a little. When adding the content directory into the Content Manager, users will need to add the %USERPROFILE%\.nuget\packages\geonbit.ui\4.1.0.1\content\Content\ directory. This will then appropriately add the content in the expected folder/file hierarchy that the GeonBit.UI library expects.
In the README.md, an additional notation is also mentioned about installing the default theme fonts. The documentation should be updated to note that for Windows users, when they install the fonts, they should choose the Install for All Users option and not the standard Install option on Windows, otherwise the content build process will not find the fonts appropriately on the system. (Users on WIndows 11 need to click the "Show More Options" item after right-clicking the font file).
RonenNess
commented
12 months ago
Description
When adding
GeonBit.UIto an existing project, the NuGet does not include theGeonBit.UI.Examplesdirectory as described in step 2 in the Via Nuget section of the README.mdSteps to reproduce
The following are the steps to reproduce in my use-case using Visual Studio Code and the terminal to create the project and add the NuGet package
The above steps create a
ExampleSolution.slnfile and an example MonoGame DesktopGL project calledExampleProjectthen adds that project to the solution. Then performs a dotnet restore. Next it changes into theExampleProjectdirectory and adds theGeonBit.UINuGet package to the project.Expected Result
Step 2 of the installation instructions states that the installation would place a folder in
GeonBit.Ui.Examples\Content\GeonBit.UI.Actual Result
By default, NuGet packages are downloaded to
%USERPROFILE%\.nuget\packages\. TheGeonBit.UIpackage is downloaded to%USERPROFILE%\.nuget\packages\geonbit.uias expected, but within the package there is noGeonBit.UI.Examplesdirectory.Additional Notes
Even understanding what the documentation is trying to say, it's still misleading a little. When adding the content directory into the Content Manager, users will need to add the
%USERPROFILE%\.nuget\packages\geonbit.ui\4.1.0.1\content\Content\directory. This will then appropriately add the content in the expected folder/file hierarchy that theGeonBit.UIlibrary expects.In the README.md, an additional notation is also mentioned about installing the default theme fonts. The documentation should be updated to note that for Windows users, when they install the fonts, they should choose the
Install for All Usersoption and not the standardInstalloption on Windows, otherwise the content build process will not find the fonts appropriately on the system. (Users on WIndows 11 need to click the "Show More Options" item after right-clicking the font file).