modify readme to add a description and a development setup guide

This commit is contained in:
Emily Daemon 2023-07-27 15:15:35 +03:00
parent 2fd1b3f10e
commit 4678946bc7

View File

@ -1,3 +1,26 @@
# libreshop_client
# LibreShop
Wii Homebrew downloader
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.
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
```