Encompass-FNA-Template/README.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

2020-03-04 00:03:33 +00:00
# FNA-VSCode-Template
Template and build tasks for developing a cross-platform multi-target .NET Framework 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
## Requirements
2020-03-04 00:25:53 +00:00
- [Git](https://git-scm.com/)
- [Git for Windows](https://gitforwindows.org/) if on Windows
2020-03-04 00:03:33 +00:00
- [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/)
## Installation
2020-03-04 00:25:53 +00:00
- Make sure you have Git Bash from Git for Windows if you are on Windows
2020-03-04 00:03:33 +00:00
- Download this repository
2020-03-04 00:25:53 +00:00
- Run `install.sh`
2020-03-04 00:22:12 +00:00
- Move the newly created project directory wherever you want
## Usage
- Open the project directory in VSCode
- Press Ctrl-Shift-B to open the build tasks menu
2020-03-04 00:23:14 +00:00
- `Framework` tasks use .NET Framework or Mono to build and run
- `Core` tasks use .NET Core to build and run
- Press F5 to build and debug with Core Debugger
2020-03-04 00:03:33 +00:00
## Acknowledgments
Thanks to Andrew Russell and Caleb Cornett's FNA templates for a starting point for this template.