Baekalfen / PyBoy

Game Boy emulator written in Python
Other
4.57k stars 472 forks source link

Add RGBDS to install instructions to Wiki #330

Closed stangerm2 closed 3 months ago

stangerm2 commented 3 months ago

Seems like you can't do PR for Wiki update??? So here's a patch to add install instructions, hope it helps:

From: Matthew Stanger <stangerm2@gmail.com>
Date: Mon, 3 Jun 2024 22:36:12 -0700
Subject: [PATCH] Add rgbds install instructions

This seems to be a missing build dependency, this add's
instructions on how to build and install that dependency for
unix systems.
---
 Installation.md | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Installation.md b/Installation.md
index 55fca0b..63f36c7 100644
--- a/Installation.md
+++ b/Installation.md
@@ -131,8 +131,13 @@ To enable rewind, see more in the section [experimental features](https://github

 Building from Source
 ====================
-If you want to build from source, follow the instructions above for your platform, but don't do `pip install pyboy`. If PyBoy is already installed, make sure to uninstall it with `pip uninstall pyboy`. Run the uninstall more than once, to make sure you don't have multiple versions installed.
+If you want to build from source, follow the instructions above for your platform, but stop before the last step: `pip install pyboy`. If PyBoy is already installed, make sure to uninstall it with `pip uninstall pyboy`. Run the uninstall more than once, to make sure you don't have multiple versions installed.

+Next clone and build RGBDS (Rednex Game Boy Development System).
+
+    > git clone git@github.com:gbdev/rgbds.git
+    > sudo make install
+    
 Then type the following lines in your terminal.

     > python3 -m pip install -r requirements.txt
-- 
2.40.1
Baekalfen commented 3 months ago

Thank you, I'll update it. Although I'll just refer to the RGBDS installation page, as git clone/make is not preferred for all platforms https://rgbds.gbdev.io/install