From acb3150212c1e34e2498480a5efccd2aa8866295 Mon Sep 17 00:00:00 2001 From: deccer Date: Sun, 6 Aug 2023 19:21:27 +0200 Subject: [PATCH] Adjust README fixes #16 --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 086d7f7..6a35277 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,28 @@ It tries to hide the ugliness of the global state machine that is OpenGL. ## Getting Started +It is a little cumbersome, but bare with me. + Create two projects - `YourProject` as a console project -- `YourProject.Assets` as a class library project +- `YourProject.Assets` as a class library project (your IDE might have created a `Class1.cs` file, you can delete that safely) --- - Add `YourProject.Assets` as a project reference to `YourProject`. - Copy `Fonts` directory from [here](https://github.com/deccer/EngineKit/tree/main/examples/ForwardRendering/ForwardRendering.Assets) into `YourProject.Assets` (i am working on a neater solution) - Add `EngineKit` to `YourProject` via nuget as a usual package. +- We also need a few other packages: + - `Microsoft.Extensions.Configuration` - handle configuration in general + - `Microsoft.Extensions.Configuration.Json` - to load appsettings.json + - `Microsoft.Extensions.Options.ConfigurationExtensions` - to turn sections of the configuration into usable objects + - `Microsoft.Extensions.DependencyInjection` - that's the dependency injection container we use here + - `Serilog.Sinks.Console` - to print log statement to the console + - `Serilog.Settings.Configuration` - an adapter for serilog to get its configuration from our configuration object - Create an `appsettings.json` in `YourProject` which should like like [this](https://github.com/deccer/EngineKit/blob/main/examples/ForwardRendering/ForwardRendering/appsettings.json) one. - Make sure to have it copied when its newer by right clicking it -> Properties -> "Copy to output directory" -> "Copy if newer" --- -- Create a class `YourProjectApplication` in `YourProject` and let it derive from `GraphicsApplication` (let your IDE implement the ctor) +- Create a class `YourProjectApplication` in `YourProject` and let it derive from `GraphicsApplication` (let your IDE implement the constructor, if you cannot figure it out look at [this constructor for inspiration](https://github.com/deccer/EngineKit/blob/main/examples/ForwardRendering/ForwardRendering/ForwardRendererApplication.cs#L69C26-L69C26)) - `Program.cs` of `YourProject` should look like ```cs using EngineKit;