Final polishing for 0.0.1 release

- Updated README.md: * Added Polish locales * Ability to download script using button in README.md - Updated compatibility list.
mavethee · Aug 4, 2023 · daea27d · daea27d
1 parent 697515e
commit daea27d
Show file tree

Hide file tree

Showing 4 changed files with 188 additions and 24 deletions.
diff --git a/Compatibility.md b/Compatibility.md
@@ -1,16 +1,23 @@
 # Compatibility List
 
+[🇵🇱 Szukasz Polskiego? Kliknij tutaj](Compatibility_pl_PL.md) [🇺🇸 You are reading English version](Compatibility.md)
+
 ## Known working games: 
-Here is a list of some games that have been tested and go in-game. It is not a complete list, there are probably more that work: 
+Here is a list of some games that have been tested and go in-game. It is not a complete list, there are probably more that work.
+
 - Persona 5 Royal
 - Return of the Obra Dinn
 - Salt & Sanctuary
 - Final Fantasy Pixel Remasters
 - Hollow Knight
-- The Legend of Zelda: Link's Awakening
-
 ## Known non-working games:
-Here is a list of some games that have been tested and do not go in-game. It is not a complete list, there are probably more that don't work:
+Here is a list of some games that have been tested and do not go in-game. It is not a complete list, there are probably more that don't work.
+
 - Super Mario Odyssey
 - The Legend of Zelda: Tears of The Kingdom
 - The Legend of Zelda: Breath of The Wild
+
+## Unknown regressions:
+Here is a list of games that definitely worked before but now they aren't. It is not a complete list, and probably will grow.
+
+- The Legend of Zelda: Link's Awakening
diff --git a/Compatibility_pl_PL.md b/Compatibility_pl_PL.md
@@ -0,0 +1,23 @@
+# Kompatybilność:
+
+[🇵🇱 Czytasz polską wersje strony](README_pl_PL.md) [🇺🇸 Go to English version](README.md)
+
+## Znane działające tytuły: 
+Jest to lista wybranych przetestowanych gier, które działają poza ekranem tytułowym. Nie jest to kompletna lista, jest ich na pewno więcej.
+
+- Persona 5 Royal
+- Return of the Obra Dinn
+- Salt & Sanctuary
+- Final Fantasy Pixel Remasters
+- Hollow Knight
+## Znane niedziałające tytuły:
+Jest to lista wybranych przetestowanych gier które nie uruchamiają się wcale lub poza ekran tytułowy. Nie jest to kompletna lista, jest ich na pewno więcej.
+
+- Super Mario Odyssey
+- The Legend of Zelda: Tears of The Kingdom
+- The Legend of Zelda: Breath of The Wild
+
+## Gry, które zaliczyły regres:
+Gry, które działały, ale nie jestem pewny, czemu przestały działać.
+
+- The Legend of Zelda: Link's Awakening
diff --git a/README.md b/README.md
@@ -1,10 +1,14 @@
 <img src="https://raw.githubusercontent.com/yuzu-emu/yuzu-assets/master/icons/icon.png" width="10%" height="10%"/> 
 
-## Yuzu's macOS build and compile script:
+## Yuzu's macOS builds compiling script
+
+[🇵🇱 Szukasz Polskiego? Kliknij tutaj](README_pl_PL.md) [🇺🇸 You are reading English version](README.md)
 
 This script will build and compile Yuzu for macOS.
 
-Remember to not expect miracles, it's not ready for end users yet. The macOS build is still in development!
+Remember to not expect miracles, it's not ready for end users yet. 
+
+The macOS build is still in development!
 
 This script is based off of these build instructions:
 
@@ -14,24 +18,55 @@ https://yuzu-emu.org/wiki/building-for-macos/
 
 https://github.com/yuzu-emu/yuzu
 
-# Instructions:
+[![Download](https://img.shields.io/badge/Download-v0.0.1-brightgreen)](https://github.com/mavethee/yuzu-macos-builds-script/releases/download/0.0.1/build_yuzu.sh)
+
+## Usage:
+
+After downloading, double click and follow the prompts.
+
+Preferrably execute in your home directory.
+
+On base M1, building takes ~4mins (measured including gathering needed dependencies which differs on your internet speed)
+
+In case of any permission issues, run:
+
+```
+chmod +x ./build_yuzu.sh
+```
+
+Yuzu currently does not support a lot of required features such as Geometry Shaders or Transform Feedback Buffers. </br>
+If a game you are trying to play uses these features, it will crash.
+If you want to know what missing feature is causing the crash, run yuzu through Terminal: </br>
+
+```
+/Applications/yuzu.app/Contents/MacOS/yuzu
+```
+
+The situation will get better in the future as MoltenVK adds support for more features.
+
+## Check current compatibility:
+
+[Compatiblity List](Compatibility.md)
 
-## 1. Clone the repository (or Code -> Download ZIP). Examples here use the $HOME directory:
+## Building:
+
+## 1. Clone the repository to your home directory:
 
 ```
-$HOME && git clone https://github.com/mavethee/yuzu-macos-builds-script.git
+git clone https://github.com/mavethee/yuzu-macos-builds-script.git
+cd yuzu-macos-builds-script
 ```
 
 ## 2. Make sure cloned repo is up to date:
 
 ```
-cd $HOME/yuzu-macos-builds-script && git pull origin main
+git pull origin main
 ```
 
-## 3. Move the script to a location on your drive:
+## 3. Copy the script to a location on your home directory:
 
 ```
-mv build_yuzu.sh $HOME
+ditto build_yuzu.sh $HOME/build_yuzu.sh
 ```
 
 ## 4. Make the script executable:
@@ -49,25 +84,20 @@ $HOME/build_yuzu.sh
 ## 6. Enjoy!
 
 Note: Remember to repeat STEP 2 for future script changes. </br>
-Yuzu currently does not support a lot of required features such as Geometry Shaders or Transform Feedback Buffers. </br>
-If a game you are trying to play uses these features, it will crash.
-If you want to know what missing feature is causing the crash, run yuzu through Terminal. </br>
-The situation will get better in the future as MoltenVK adds support for more features.
-
-# Credits:
+## Credits:
 
 - Yuzu team:
 
-https://github.com/yuzu-emu
+ https://github.com/yuzu-emu
 
-(give those dudes a tip here: https://www.patreon.com/yuzuteam)
+ (🍺 Give those dudes a tip here: https://www.patreon.com/yuzuteam)
 
 - Yuzu's macOS build instructios:
 
-https://yuzu-emu.org/wiki/building-for-macos/
+ https://yuzu-emu.org/wiki/building-for-macos/
 
-...and ChatGPT with GitHub Copilot for making my drunkass shell coding public.
+ ...and ChatGPT with GitHub Copilot for making my drunkass shell coding public.
 
-If I get sued by Big N, come visit my grave ^^
+ If I get sued by Big N, come visit my grave ^^
 
-![hippo](https://media.tenor.com/uH3ibKuHMSQAAAAC/anime-citrus.gif)
+ ![hippo](https://media.tenor.com/uH3ibKuHMSQAAAAC/anime-citrus.gif)
diff --git a/README_pl_PL b/README_pl_PL
@@ -0,0 +1,104 @@
+<img src="https://raw.githubusercontent.com/yuzu-emu/yuzu-assets/master/icons/icon.png" width="10%" height="10%"/> 
+
+## Skrypt kompilujący port Yuzu na systemy macOS
+
+[🇵🇱 Czytasz polską wersje strony](README_pl_PL.md) [🇺🇸 Go to English version](README.md)
+
+Ten skrypt pobierze wszystkie potrzebne rzeczy dla portu Yuzu na macOS.
+
+Weź pod uwagę, żeby nie nastawiać się na wiele, w obecnym stanie nie jest to w pełni funkcjonalny port. 
+
+Prace na portem na macOS wciąż trwają!
+
+Skrypt bazuje na tym artykule:
+
+https://yuzu-emu.org/wiki/building-for-macos/
+
+## Oficjalne repozytorium Yuzu na GitHubie:
+
+https://github.com/yuzu-emu/yuzu
+
+[![Pobierz](https://img.shields.io/badge/Download-v0.0.1-brightgreen)](https://github.com/mavethee/yuzu-macos-builds-script/releases/download/0.0.1/build_yuzu.sh)
+
+## Użytkowanie:
+
+Po pobraniu, otwórz podwójnym klinięciem i postępuj zgodnie z poleceniami.
+
+Preferowane odpalenie skryptu w katalogu domowym.
+
+Na podstawowej konfiguracji z M1, kompilowanie trwa ~4 minuty (pomiar wraz z pobieraniem potrzebnych programów, zależne od twojego połączenia internetowego).
+
+Wrazie problemów z uprawnieniami:
+
+```
+chmod +x ./build_yuzu.sh
+```
+
+Obecnie yuzu nie wspiera wielu wymaganych funkcji jak na przykład Geometry Shaders lub Transform Feedback Buffers.</br>
+Jeśli twoja gra używa niewspieranych funkcji, yuzu się scrashuje.
+Jeśli chcesz poznać szczegóły na temat crasha danej gry, odpal Yuzu za pomocą Terminala: </br>
+
+```
+/Applications/yuzu.app/Contents/MacOS/yuzu
+```
+
+Sytuacja może ulec zmianie w przyszłości, gdy tylko MoltenVK doda wspracie dla większej ilości funkcji.
+
+## Sprawdź obecną kompatybilność:
+
+[Kompatybiliność](Compatibility_pl_PL.md)
+
+## Kompilacja:
+
+## 1. Sklonuj repozytorium:
+
+```
+git clone https://github.com/mavethee/yuzu-macos-builds-script.git
+cd yuzu-macos-builds-script
+```
+
+## 2. Upewnij się że repozytorium jest aktualne:
+
+```
+git pull origin main
+```
+
+## 3. Skopiuj skrypt do swojego katalogu głównego:
+
+```
+ditto build_yuzu.sh $HOME/build_yuzu.sh
+```
+
+## 4. Nadaj uprawnienia skryptowi:
+
+```
+chmod +x $HOME/build_yuzu.sh
+```
+
+## 5. Uruchom skrypt:
+
+```
+$HOME/build_yuzu.sh
+```
+
+## 6. Enjoy!
+
+Notka: Pamiętaj o powtórzeniu kroku drugiego co jakiś czas, aby mieć najaktualniejszy skrypt. </br>
+
+## Podziękowania:
+
+- Yuzu team:
+
+ https://github.com/yuzu-emu
+
+ (🍺 Postawcie im piwo: https://www.patreon.com/yuzuteam)
+
+- Instrukcje kompilacji projektu na macOS:
+
+ https://yuzu-emu.org/wiki/building-for-macos/
+
+ ...i ChatGPT wraz z GitHub Copilot za umożliwienie publikacji mojego pijackiego kodu.
+
+ Jeśli zostanę pozwany przez Big N, zapraszam na mój grób ^^
+
+ ![hippo](https://media.tenor.com/uH3ibKuHMSQAAAAC/anime-citrus.gif)