From 86f568fe523a8d3d819a86125da1eff6b04cfcec Mon Sep 17 00:00:00 2001 From: cosmonaut Date: Wed, 9 Feb 2022 23:03:56 -0800 Subject: [PATCH] readme --- README.md | 46 ++-------------------------------------------- 1 file changed, 2 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 8c3613c..9c46b93 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,3 @@ -# MoonWorksTemplate +# MoonWorksMultiWindow -Template and build tasks for developing a cross-platform multi-target .NET Framework, Mono, and .NET 5 MoonWorks project in VSCode. - -The generated solution file will also work in regular Visual Studio. - -NOTE: OSX is broken right now because I need to set up MoltenVK. - -## Features - -- Includes project boilerplate code -- Build tasks for both .NET Framework, Mono, and .NET 5 side by side -- VSCode debugger integration - -## Requirements - -- [Git](https://git-scm.com/) or [Git for Windows](https://gitforwindows.org/) on Windows -- [.NET 5 SDK](https://dotnet.microsoft.com/download/dotnet/5.0) -- [.NET Framework 4.7.2 Developer Pack](https://dotnet.microsoft.com/download/dotnet-framework/net472) on Windows -- [Build Tools for Visual Studio 2019](https://visualstudio.microsoft.com/downloads/) on Windows -- [Mono](https://www.mono-project.com/) on OSX or Linux -- [Visual Studio Code](https://code.visualstudio.com/) -- [VSCode C# Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp) -- [VSCode Mono Debug Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.mono-debug) if debugging using Mono - -## Installation - -- Make sure you have Git Bash from Git for Windows if you are on Windows -- Download this repository -- Run `install.sh` -- Move the newly created project directory wherever you want -- On Windows, add `C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin` to your system environment PATH variable after installing Build Tools for VS 2019 - -## Usage - -- Open the project directory in VSCode -- Press Ctrl-Shift-B to open the build tasks menu -- `Framework` tasks use .NET Framework to build and run (Windows only) -- `Mono` tasks use Mono to build and run -- `.NET 5` tasks use .NET 5 to build and run -- Press F5 to build and debug - -## Acknowledgments - -Thanks to Andrew Russell and Caleb Cornett's FNA templates for a starting point for this template. +A toy example demonstrating threaded multi-window usage in MoonWorks. \ No newline at end of file