add notes about building on windows
parent
be35d44944
commit
d27aee2705
23
README.md
23
README.md
|
@ -1,22 +1,23 @@
|
|||
# FNA-VSCode-Template
|
||||
|
||||
Template and build tasks for developing a cross-platform multi-target .NET Framework and .NET Core FNA project in VSCode.
|
||||
Template and build tasks for developing a cross-platform multi-target .NET Framework, Mono, and .NET Core FNA project in VSCode.
|
||||
|
||||
## Features
|
||||
|
||||
- Includes project boilerplate code
|
||||
- Build tasks for both .NET Framework and .NET Core side by side
|
||||
- Press F5 to build and debug in-editor with Core Debugger
|
||||
- Build tasks for both .NET Framework, Mono, and .NET Core side by side
|
||||
- VSCode debugger integration
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Git](https://git-scm.com/)
|
||||
- [Git for Windows](https://gitforwindows.org/) if on Windows
|
||||
- [Git](https://git-scm.com/) or [Git for Windows](https://gitforwindows.org/) on Windows
|
||||
- [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core)
|
||||
- [.NET Framework 4.8 SDK](https://dotnet.microsoft.com/download/visual-studio-sdks) 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)
|
||||
- [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core)
|
||||
- [.NET Framework SDK](https://dotnet.microsoft.com/download/visual-studio-sdks) or [Mono](https://www.mono-project.com/)
|
||||
|
||||
- [VSCode Mono Debug Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.mono-debug) if debugging using Mono
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -24,14 +25,16 @@ Template and build tasks for developing a cross-platform multi-target .NET Frame
|
|||
- 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 or Mono to build and run
|
||||
- `Framework` tasks use .NET Framework to build and run (Windows only)
|
||||
- `Mono` tasks use Mono to build and run
|
||||
- `Core` tasks use .NET Core to build and run
|
||||
- Press F5 to build and debug with Core Debugger
|
||||
- Press F5 to build and debug
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
|
|
Loading…
Reference in New Issue