From 3115105343b95de8599b374f9cad0f0b5df807f0 Mon Sep 17 00:00:00 2001 From: NinjaCheetah <58050615+NinjaCheetah@users.noreply.github.com> Date: Mon, 22 Jul 2024 02:56:12 -0400 Subject: [PATCH] Minor README changes --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 69e17cb..ce05685 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ WiiPy is cross-platform, and supports macOS, Windows, and Linux, both because it To see what features are supported, I would recommend checking out the list of features that libWiiPy offers, which can be found [here]("https://github.com/NinjaCheetah/libWiiPy?tab=readme-ov-file#features"). + ## Requirements libWiiPy has been tested on both Python 3.11 and 3.12, and works as expected in both places. libWiiPy *should* support Python 3.10, however this is not verified. WiiPy only relies on libWiiPy, so it supports the same Python versions. @@ -13,6 +14,7 @@ To make sure you have libWiiPy and all of its dependencies, you can simply run: pip install -r requirements.txt ``` + ## Usage Basic usage for WiiPy is very simple. ```shell @@ -20,7 +22,8 @@ python3 wiipy.py ``` You can use `--help` to see a list of all subcommands, or use ` --help` to see usage instructions for that subcommand. -Available subcommands will expand as support for more features are added into libWiiPy. WiiPy is designed around libWiiPy's `main` branch, so any features that have been merged into main are likely to be supported here within a short period of time. This also means that any breaking changes to the library will be handled here quickly, so incompatibilities shouldn't happen. +Available subcommands will expand as support for more features are added into libWiiPy. WiiPy is designed around libWiiPy's `main` branch, so any features that have been merged into main are likely to be supported here within a short period of time. This also means that any updates to the library will be addressed here quickly, so breaking changes in libWiiPy shouldn't cause issues. + ## Compiling If you'd like to compile WiiPy from Python into something a little more native, you can use one of the following commands. Make sure you've installed Nuitka first (it's included in `requirements.txt`). @@ -29,7 +32,6 @@ python -m nuitka --show-progress --assume-yes-for-downloads --onefile wiipy.py ``` On macOS and Linux, this will give you a binary named `wiipy.bin` in the same directory as the Python file. On Windows, you'll get a binary named `wiipy.exe` instead. - ### For Linux Users: A Makefile has been included to both build and install WiiPy on Linux. This will install `wiipy` to `/usr/bin/`.