From d7b4b6e4fd683032abc5b814368d9215b2b6b295 Mon Sep 17 00:00:00 2001 From: Evan Hemsley Date: Sat, 11 Jul 2020 18:26:50 -0700 Subject: [PATCH] proper README --- README.md | 39 ++------------------------------------- 1 file changed, 2 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 4462ea0..b903978 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,3 @@ -# Encompass-FNA-Template +# PongFE -Template (and VSCode build tasks) for developing a cross-platform multi-target .NET Framework and .NET Core game using Encompass and FNA. - -## 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 - -- [Git](https://git-scm.com/) -- [Git for Windows](https://gitforwindows.org/) if on Windows -- [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 - -- 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 - -## 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 -- `Core` tasks use .NET Core to build and run -- Press F5 to build and debug with Core Debugger - -## Acknowledgments - -Thanks to Andrew Russell and Caleb Cornett's FNA templates for a starting point for this template. +A simple recreation of Pong using Encompass and FNA as an intro to making games with these frameworks.