From fd52bd64c44ee7eb344a394dd1f6c041772993a5 Mon Sep 17 00:00:00 2001 From: Clement Date: Wed, 31 Aug 2022 15:44:17 +0200 Subject: [PATCH] Added a section in README.md to explain how to build from source --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e5ee556..e5976d2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ GameShortcut is a utility to build shortcuts to games in the Games section of th ## How to use - Download the latest release in the [releases section](https://github.com/ClementDreptin/GameShortcut/releases). -- Modify `config\gameInfo.txt` and respect the following format +- Modify `config\shortcutInfo.txt` and respect the following format ``` @@ -20,6 +20,9 @@ GameShortcut is a utility to build shortcuts to games in the Games section of th ## How it works This project is split in two. The first part is the shortcut application itself (that runs on the console) and the second part is a Windows console application (that runs on a computer) to build the shortcut and send it to the console. -The shortcut application is a regular XEX file, so not exactly a shortcut just yet. All it does is reading the `config\gameInfo.txt` file to get the path to the XEX file the shortcut is made for and launches it. +The shortcut application is a regular XEX file, so not exactly a shortcut just yet. All it does is reading the `config\shortcutInfo.txt` file to get the path to the XEX file the shortcut is made for and launches it. -The Windows console application creates an XML configuration file from the name of the shortcut in `config\gameInfo.txt` and builds a Demo game for it with BLAST (console application provided with the XDK). BLAST takes care of deploying the Demo game to the console in the right directory. When the operation completes (successfully or not), the XML configuration file and the files generated by BLAST are deleted automatically. +The Windows console application creates an XML configuration file from the name of the shortcut in `config\shortcutInfo.txt` and builds a Demo game for it with BLAST (console application provided with the XDK). BLAST takes care of deploying the Demo game to the console in the right directory. When the operation completes (successfully or not), the XML configuration file and the files generated by BLAST are deleted automatically. + +## Building +To build from source, open `GameShortcut.sln` in Visual Studio (this solution is configured for Visual Studio 2019). The two projects have separate target platforms, `GameShortcut` only builds for the `Xbox 360` platform and `Publisher` only builds for the `Win32` platform. Simply building the whole solution will only build the project configured for the currently selected platform. To build everything, select the `Xbox 360` platform and build `GameShortcut` then select the `Win32` platform and build `Publisher`. You can then run `Publisher` by clicking `F5`, it is set as the startup project.