From 1cf974c2ceba2faa20b88c1edd625214d3163fee Mon Sep 17 00:00:00 2001 From: Doprez <73259914+Doprez@users.noreply.github.com> Date: Mon, 28 Aug 2023 10:15:21 -0600 Subject: [PATCH] added some noob helpful tips --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 944c139..99e4677 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,14 @@ You can find a comprehensive demo project in the `DotRecast.Recast.Demo` folder. ### Building DotRecast.Recast.Demo -`DotRecast.Recast.Demo` uses [dotnet 7](https://dotnet.microsoft.com/) to build platform specific projects. Download it and make sure it's available on your path, or specify the path to it. +1. `DotRecast.Recast.Demo` uses [dotnet 7](https://dotnet.microsoft.com/) to build platform specific projects. Download it and make sure it's available on your path, or specify the path to it. +2. Open a command prompt, point it to a directory and clone DotRecast to it: `git lfs clone https://github.com/ikpil/DotRecast.git` + - Note that when you use GitHub -> Code -> Download ZIP, this doesn't support Large File Support ```lfs```, make sure you use the command above or that your git client does it for you +3. Open `\DotRecast.sln` with Visual Studio 2022 and build `DotRecast.Recast.Demo` + - Optionally, you can run using the `dotnet run` command with `DotRecast.Recast.Demo.csproj` #### Windows + - need to install [microsoft visual c++ redistributable package](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) #### Linux & macOS & Windows @@ -48,6 +53,14 @@ You can find a comprehensive demo project in the `DotRecast.Recast.Demo` folder. ### Running Unit tests +#### With VS2022 + +- In Visual Studio 2022 go to the test menu and press `Run All Tests` + +#### With CLI + +- in the DotRecast folder open a command prompt and run `dotnet test` + ## Integrating with your game or engine It is recommended to add the source directories `DotRecast.Core`, `DotRecast.Detour.Crowd`, `DotRecast.Detour.Dynamic`, `DotRecast.Detour.TitleCache`, `DotRecast.Detour.Extras` and `DotRecast.Recast` into your own project depending on which parts of the project you need. For example your level building tool could include `DotRecast.Core`, `DotRecast.Recast`, and `DotRecast.Detour`, and your game runtime could just include `DotRecast.Detour`.