Skip to content

Commit

Permalink
Made Read Me make a bit more sense
Browse files Browse the repository at this point in the history
  • Loading branch information
Chopper1337 committed Jan 31, 2021
1 parent aeec3ce commit c7b2d08
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Unofficial Xenia Updater
Small program made to manage Xenia emulator and its versions.

# Releases

# [Download stable release here](https://github.com/Chopper1337/XeniaUpdater/raw/main/bin/Release/XeniaUpdater.exe)
* [**Stable**](https://github.com/Chopper1337/XeniaUpdater/raw/main/bin/Release/XeniaUpdater.exe)
* [Testing](https://github.com/Chopper1337/XeniaUpdater/raw/main/bin/Debug/XeniaUpdater.exe)

# Features

Expand All @@ -11,15 +13,6 @@ Small program made to manage Xenia emulator and its versions.
* Creates a backup of the last downloaded version of Xenia (xenia_master.zip and/or xenia_canary.zip)
* Updating the updater itself, from the updater itself. No need to open a browser

[Download testing release here](https://github.com/Chopper1337/XeniaUpdater/raw/main/bin/Debug/XeniaUpdater.exe)

Provided you don't run into issues with the testing release, go ahead and use it.

If you run into any issues, message me on Discord "[IRB] Chopper#4291".
Try provide as much info as possible, screenshot of when the issue occurred and a screenshot of the directory the updater was in and so on.

Thanks :)

# Info for anyone who plans to modify this code

Form1.cs contains the "Important strings":
Expand All @@ -33,4 +26,13 @@ Updating the updater is done by downloading latest raw binary from GitHub with a

The "forceful extraction" option exists for the case the the updater does not extract the zip. We can tell the zip was not extracted when the expected Xenia binary is not present, so on this condition, we prompt the user to try the forceful extraction option which should extract the zip successfully.

This code is not written in the most efficient way, it is probably possible to divide this into a few methods which are applicable to both Xenia Master and Xenia Canary, giving the opportunity to reuse code.
This code is not written in the most efficient way, it is probably possible to divide this into a few methods which are applicable to both Xenia Master and Xenia Canary, giving the opportunity to reuse code.

# Note for "Testing" release

There is no guarantee of stability with the testing release.

If you run into any issues, message me on Discord **[IRB] Chopper#4291**.
Try provide as much info as possible, screenshot of when the issue occurred and a screenshot of the directory the updater was in and so on.

Thanks :)

0 comments on commit c7b2d08

Please sign in to comment.