From 1b4324e9b81f32dec7c9109eca039f8705982aa9 Mon Sep 17 00:00:00 2001 From: NinjaCheetah <58050615+NinjaCheetah@users.noreply.github.com> Date: Wed, 21 Aug 2024 18:20:08 -0400 Subject: [PATCH] Update README with platform-specific usage information --- .github/ISSUE_TEMPLATE/bug_report.md | 18 +++++++++++------- README.md | 8 ++++++++ 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 48a553b..fa3100d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,16 +7,20 @@ assignees: '' --- -**Describe the bug** +### Describe the bug -**To Reproduce** +### Steps to Reproduce -**Screenshots (optional)** +### Screenshot(s) (if applicable) -**Computer (please complete the following information):** - - OS: - - NUSGet version: - - Python version: +### System information: + - **OS and version:** + - **NUSGet version:** + +If you're running the app from source, provide the below information: + - **Are you compiling NUSGet, or running the Python script directly?** + - **Python version:** + - **Installed libWiiPy version:** diff --git a/README.md b/README.md index 5e2e780..4b33369 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,14 @@ The following features are available for all supported consoles: **For DSi titles only:** - "Pack installable archive (WAD/TAD)": Pack the encrypted contents, TMD, and Ticket into a TAD file that can be installed on a TAD or in a DSi-capable emulator. Only supported for free titles. For real hardware, these titles can be installed using [@rvtr](https://github.com/rvtr)'s handy [TAD Delivery Tool](https://github.com/rvtr/TDT). +## Using NUSGet +For basic usage on all platforms, you can download the latest release for your operating system from [here](https://github.com/NinjaCheetah/NUSGet/releases/latest), and then run the executable. + +**Platform-Specific Notes:** +- **macOS:** To use NUSGet on macOS, you'll need to either open NUSGet.app using right-click -> Open, or by using the terminal command `xattr -d com.apple.quarantine NUSGet.app`. After doing either of those things once, you'll be able to double-click NUSGet to open it like you normally would for an app. Note that changes in macOS Sequoia require using the latter method. +- **Windows:** On Windows, you'll likely need to allow NUSGet.exe in your antivirus program. This includes Windows Defender, which is almost guaranteed to prevent the app from being run. This is not because NUSGet is malicious in any way, it's just that NUSGet isn't popular enough to be "known" to Windows, and I don't have the expensive signing certificate necessary to work around this. If you're in doubt, you can look at all of NUSGet's code in this repository. +- **Linux:** No special information applies on Linux, however you can build NUSGet yourself if you'd like to have it as an installed application with an icon that will appear in your favorite application launcher. See [here](https://github.com/NinjaCheetah/NUSGet?tab=readme-ov-file#for-linux-users) for more information. + ## Building ### System Requirements - **Windows:** Python 3.11 (Requires Windows 8.1 or later)