From 4678946bc7743f79e275368e8e8cef443fcb051d Mon Sep 17 00:00:00 2001
From: emilyd <jornmann32@gmail.com>
Date: Thu, 27 Jul 2023 15:15:35 +0300
Subject: [PATCH] modify readme to add a description and a development setup
 guide

---
 README.md | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 9e55e26..c9f1174 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.
+
+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
+```