Skip to content

Commit e8d0339

Browse files
committed
review revisions
- rephrased opening - added note regarding manual building of PSL1GHT and `make install` - add `sh` formatting to two code blocks that were missing it - restore callback comment
1 parent 5c48775 commit e8d0339

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@
33

44
# PSL1GHT
55

6-
PSL1GHT is an open-source PlayStation 3 homebrew SDK. It provides libraries
7-
and build tools for creating GameOS homebrew applications as SELF executables
8-
and installable PKG packages.
6+
PSL1GHT is an open-source PlayStation 3 homebrew SDK. It provides libraries for
7+
GameOS homebrew applications created using the PS3 toolchain.
98

109
> [!NOTE]
1110
> This is the SDK repository.
@@ -28,6 +27,14 @@ tools and other programs required by PSL1GHT.
2827
Building PSL1GHT directly is useful when developing PSL1GHT itself or testing changes.
2928
A working PS3 toolchain must already be installed.
3029

30+
> [!NOTE]
31+
> `make install` will overwrite the global PSL1GHT installation.
32+
> If you do not want this, you may want to temporarily change $PSL1GHT to a separate location
33+
> while working on a locally modified version.
34+
>
35+
> `make install` also installs parts into $PS3DEV; however, you cannot point $PS3DEV to an
36+
> empty location, as the Makefiles will then fail to find the toolchain.
37+
3138
```sh
3239
git clone https://github.com/ps3dev/PSL1GHT.git
3340
cd PSL1GHT
@@ -41,7 +48,7 @@ make install
4148
into `$PSL1GHT` and `$PS3DEV`.
4249

4350
To remove generated build files:
44-
```
51+
```sh
4552
make clean
4653
```
4754

@@ -51,7 +58,7 @@ PSL1GHT programs are built using their Makefile. The repository currently provid
5158
samples organised by subsystem, such as `audio`, `graphics` and `input`.
5259

5360
To build an individual sample:
54-
```
61+
```sh
5562
cd samples/<category>/<sample>
5663
make
5764
```
@@ -60,8 +67,10 @@ target can be packaged with
6067
```sh
6168
make pkg
6269
```
63-
Package metadata is set
64-
by the application's Makefile.
70+
71+
Package metadata is set by the application's Makefile. Quitting from the XMB requires the
72+
application to register a callback to handle the event; an example can be found in the
73+
camera sample.
6574

6675
## Optional Dependencies
6776

0 commit comments

Comments
 (0)