Skip to content

Commit acb3150

Browse files
committed
Adjust README fixes #16
1 parent 71360af commit acb3150

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,28 @@ It tries to hide the ugliness of the global state machine that is OpenGL.
88

99
## Getting Started
1010

11+
It is a little cumbersome, but bare with me.
12+
1113
Create two projects
1214

1315
- `YourProject` as a console project
14-
- `YourProject.Assets` as a class library project
16+
- `YourProject.Assets` as a class library project (your IDE might have created a `Class1.cs` file, you can delete that safely)
1517
---
1618

1719
- Add `YourProject.Assets` as a project reference to `YourProject`.
1820
- 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)
1921
- Add `EngineKit` to `YourProject` via nuget as a usual package.
22+
- We also need a few other packages:
23+
- `Microsoft.Extensions.Configuration` - handle configuration in general
24+
- `Microsoft.Extensions.Configuration.Json` - to load appsettings.json
25+
- `Microsoft.Extensions.Options.ConfigurationExtensions` - to turn sections of the configuration into usable objects
26+
- `Microsoft.Extensions.DependencyInjection` - that's the dependency injection container we use here
27+
- `Serilog.Sinks.Console` - to print log statement to the console
28+
- `Serilog.Settings.Configuration` - an adapter for serilog to get its configuration from our configuration object
2029
- Create an `appsettings.json` in `YourProject` which should like like [this](https://github.com/deccer/EngineKit/blob/main/examples/ForwardRendering/ForwardRendering/appsettings.json) one.
2130
- Make sure to have it copied when its newer by right clicking it -> Properties -> "Copy to output directory" -> "Copy if newer"
2231
---
23-
- Create a class `YourProjectApplication` in `YourProject` and let it derive from `GraphicsApplication` (let your IDE implement the ctor)
32+
- 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))
2433
- `Program.cs` of `YourProject` should look like
2534
```cs
2635
using EngineKit;

0 commit comments

Comments
 (0)