Skip to content

Commit 9a9cf60

Browse files
authored
Add building instructions (#851)
* Added building instructions This can help users to contribute to the project. * fix: Improve the last part of the building section
1 parent 464eda0 commit 9a9cf60

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,44 @@ Check out the [wiki](https://github.com/Davidobot/BetterJoy/wiki)! There, you'll
5353
1. Click on it and a "Remove" button will be revealed.
5454
1. Press the "Remove" button
5555

56+
# Building
57+
58+
## Visual Studio (IDE)
59+
60+
1. If you didn't already, install **Visual Studio Community 2019** via
61+
[the official guide](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio?view=vs-2019).
62+
When asked about the workloads, select **.NET Desktop Development**.
63+
2. Get the code project via Git or by using the *Download ZIP* button.
64+
3. Open Visual Studio Community and open the solution file (*BetterJoy.sln*).
65+
4. Open the NuGet manager via *Tools > NuGet Package Manager > Package Manager Settings*.
66+
5. You should have a warning mentioning *restoring your packages*. Click on the **Restore** button.
67+
6. You can now run and build BetterJoy.
68+
69+
## Visual Studio Build Tools (CLI)
70+
1. Download **Visual Studio Build Tools** via
71+
[the official link](https://visualstudio.microsoft.com/it/downloads/#build-tools-for-visual-studio-2019).
72+
2. Install **NuGet** by following
73+
[the official guide](https://docs.microsoft.com/en-us/nuget/install-nuget-client-tools#nugetexe-cli).
74+
You should follow the section for ***nuget.exe***.
75+
Verify that you can run `nuget` from your favourite terminal.
76+
3. Get the code project via Git or by using the *Download ZIP* button.
77+
4. Open a terminal (*cmd*, *PowerShell*, ...) and enter the folder with the source code.
78+
5. Restore the NuGet dependencies by running: `nuget restore`
79+
6. Now build the app with MSBuild:
80+
```
81+
msbuild .\BetterJoy.sln -p:Configuration=CONFIGURATION -p:Platform=PLATFORM -t:Rebuild
82+
```
83+
The available values for **CONFIGURATION** are *Release* and *Debug*.
84+
The available values for **PLATFORM** are *x86* and *x64* (you want the latter 99.99% of the time).
85+
7. You have now built the app. See the next section for locating the binaries.
86+
87+
## Binaries location
88+
The built binaries are located under
89+
90+
*BetterJoyForCemu\bin\PLATFORM\CONFIGURATION*
91+
92+
where `PLATFORM` and `CONFIGURATION` are the one provided at build time.
93+
5694
# Acknowledgements
5795
A massive thanks goes out to [rajkosto](https://github.com/rajkosto/) for putting up with 17 emails and replying very quickly to my silly queries. The UDP server is also mostly taken from his [ScpToolkit](https://github.com/rajkosto/ScpToolkit) repo.
5896

0 commit comments

Comments
 (0)