diff --git a/README.md b/README.md index 9e55e26..bd2ba8b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ -# libreshop_client +# LibreShop -Wii Homebrew downloader \ No newline at end of file +LibreShop is a program that lets you download, update, and install homebrew software onto your Wii without even needing to touch a computer. + +## Development setup + +First, install the devkitppc toolchain. [Click here for a guide on how to do so.](https://devkitpro.org/wiki/Getting_Started) + +Next, install all the dependencies. +``` +# (dkp-)pacman -S ppc-jansson +``` +In addition, you'll have to download the submodule dependencies. +``` +$ git submodule init +$ git submodule update +``` + +Now all you need to do is edit, compile, and run! +``` +$ make +``` +If you have Wiiload installed and correctly setup, you can use it with the following command: +``` +$ make run +```