commit 633e584b11de0c9b80c73ab5e9192020341e5954 Author: dnesov Date: Wed Jul 2 00:10:31 2025 +0200 Add Getting Started diff --git a/Getting-Started.md b/Getting-Started.md new file mode 100644 index 0000000..479fcb9 --- /dev/null +++ b/Getting-Started.md @@ -0,0 +1,20 @@ +# Getting Started + +> [!NOTE] +> Installation process is subject to change. Currently, Voile doesn't have a dedicated NuGet package and template, so the only way to obtain it is by using it as a git submodule and referencing Voile's .csproj in your project. + +## Installing Voile as a Git submodule + +1. Create a new console project hosting your game with `dotnet new console`. +2. Add Voile as a Git submodule with `git submodule add `. For more information about submodules, refer to the [official manual](https://git-scm.com/book/en/v2/Git-Tools-Submodules). +3. Include Voile.csproj in your project's .csproj file. Example: + +```xml + + + +``` + +4. Create a new C# source file hosting your game. For an example, refer to the [Introduction](introduction.md) page. + +## Shipping your game