fries/GRRLIB
1
0
Fork 0
mirror of https://github.com/GRRLIB/GRRLIB.git synced 2025-03-15 16:30:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update documentation

Browse source
This commit is contained in:
Crayon2000 2025-02-12 21:50:54 -05:00
parent 90cb2f71bb
commit 4318a80e53
2 changed files with 16 additions and 14 deletions
.github/workflows
doc.yml
README.md

2
.github/workflows/doc.yml vendored
View file

@ -9,7 +9,7 @@ jobs:
doc:
name: Deploy documentation
runs-on: ubuntu-22.04
runs-on: ubuntu-24.04
steps:

28
README.md
View file

@ -86,26 +86,28 @@ First, you need to make sure that all required library dependencies are installe
Install them with a single command:
```bash
pacman --sync --needed --noconfirm libfat-ogc ppc-libpng ppc-freetype ppc-libjpeg-turbo
pacman --sync --needed --noconfirm libfat-ogc ppc-libpng ppc-freetype ppc-libjpeg-turbo
```
On macOS and Debian based Linux distributions you will need to use `dkp-pacman` instead of `pacman`.
Go to the directory where the code was downloaded:
```bash
c:
cd \grr
c:
cd \grr
```
To install GRRLIB with Make in a single command:
```bash
make -C GRRLIB clean all install
make -C GRRLIB clean all install
```
If you prefer to use CMake, it can also be installed with a few commands:
```bash
/opt/devkitpro/portlibs/wii/bin/powerpc-eabi-cmake -B build
/opt/devkitpro/portlibs/wii/bin/powerpc-eabi-cmake -B build
cmake --build build --target install
```
@ -119,22 +121,22 @@ Each library could also be installed individually:
To install libpngu:
```bash
cd GRRLIB\lib\pngu
make clean all install
cd GRRLIB\lib\pngu
make clean all install
```
To install libgrrlib for Wii:
```bash
cd GRRLIB\GRRLIB
make clean all install
cd GRRLIB\GRRLIB
make clean all install
```
To install libgrrlib for GameCube:
```bash
cd GRRLIB\GRRLIB
make PLATFORM=cube clean all install
cd GRRLIB\GRRLIB
make PLATFORM=cube clean all install
```
## Using GRRLIB
@ -174,7 +176,7 @@ This version now uses the ported libraries for the Wii.
To install them, use this command line:
```bash
pacman --sync --needed --noconfirm libfat-ogc ppc-libpng ppc-freetype ppc-libjpeg-turbo
pacman --sync --needed --noconfirm libfat-ogc ppc-libpng ppc-freetype ppc-libjpeg-turbo
```
You will need to add $(PORTLIBS) to the LIBDIRS line in your makefile.
@ -200,7 +202,7 @@ For example:
LIBS := -lgrrlib -lpngu `$(PREFIX)pkg-config freetype2 libpng libjpeg --libs` -lfat
```
Since GRRLIB and libpngu are now installed into the porlibs folder, make sure you don't have any leftovers from previous installations.
Since GRRLIB and libpngu are now installed into the portlibs folder, make sure you don't have any leftovers from previous installations.
You will need to manually delete unneeded libraries in _devkitPro\libogc\lib\wii_ as well as include files in _devkitPro\libogc\include_
## Using GitHub