Add readme

2023-12-14 23:56:41 +01:00
parent 36a9911a3a
commit a49e327aa9
1 changed files with 20 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,20 @@
+# Links Awakening DX HD
+
+This is an **unaffiliated fork** off [Link's Awakening DX HD](https://linksawakeningdxhd.itch.io/links-awakening-dx-hd). Currently it's just slightly easier to build/publish than the itch.io version.
+
+## Prerequisites
+
+- (Very) Basic knowledge of C# and Visual Studio
+- [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)
+    - Make sure to select `.NET desktop development` components in the visual studio installer.
+    ![image](https://gist.github.com/assets/76849026/0d14d0fc-66f3-4d74-9f3a-f9597ad580d8)
+
+## Build Instructions
+
+- Clone this repository
+- Open ProjectZ.sln
+- Build/run like any normal C# program
+
+## Publishing
+
+To publish, you can run the `publish.bat`, which will produce the folder `Publish` that you can send to your friends.