README review#165
Conversation
|
README overhauled. Read the latest commit's details for a summary. |
- "Current Status" was out of date, and its underlying model is wrong. Several of the claims listed are stale - hostname lookup is not actually "missing", the filesystem header has moved to `ppu/include`, and so on. PSL1GHT has lots of legacy code, and much of it has not been tested in years; it will be impossible to give an honest status until the SDK matures and settles post-modernisation and likely until more maintainers are on-board. Instead, it's been reframed to point towards a live source of documentation (DeepWiki) and not try to give a broad but untested feature overview. - Credits moved to the end to focus on repository status. - Change wording surrounding the PS3 toolchain (eg. "at the moment only one toolchain does so") to more accurately reflect current PS3DEV. - Remove old claim that Python 2.x is required for `fself.py`, `sfo.py` and `pkg.py`. These have since been refactored into C/C++.
- add `sh` to the markdown code blocks and add backticks where missing - fix http://github.com to https - tighten some phrasing - add link to contributors graph
| into `$PSL1GHT` and `$PS3DEV`. | ||
|
|
||
| cd /path/to/psl1ght.git/ | ||
| export PSL1GHT=/path/to/psl1ght.git/build |
There was a problem hiding this comment.
Hm, removing this will make make install overwrite the global installation of PSL1GHT, which might not be what you want when making some experimental development of PSL1GHT itself (which is what this section is about)?
There was a problem hiding this comment.
How would you suggest reframing or rephrasing this section? PSL1GHT is not going to be manually rebuilt by most users unless they are developing PSL1GHT specifically.
Your concern is valid, in that a developer may not want to overwrite their global installation - I'm just wondering if the solution here is to add a disclaimer or change the commands.
There was a problem hiding this comment.
PSL1GHT is not going to be manually rebuilt by most users unless they are developing PSL1GHT specifically.
Indeed. And it is good that the new version makes this clear. But I guess that's also why I find it notable that the new version removes a step specifically geared at this use case. 😄
I think there should at least be a sentence before the make install line pointing out that you might want to change $PSL1GHT when working on a locally modified version.
The fact that make install also install stuff in $PS3DEV makes this a little bit more messy, that wasn't even mentioned in the old README. You can't just point $PS3DEV to an empty directory because then the Makefiles won't find the toolchain... 😩
There was a problem hiding this comment.
Yes, the dependency of the toolchain and PSL1GHT upon each other has been something bucanero and I have been working to untangle. Hence the creation of the PS3DEV master repository, similar to PSPDEV, so these parts can be built separately then packaged. This is just one of those leftovers that could be messy to fix properly.
This separation of concerns is hard to do now when the environment has been structured this way for so long. For now, I think the best course of action is a notice before the make install line warning of the potential to overwrite the global installation.
| [ps3libraries](https://github.com/ps3dev/ps3libraries/). It is a collection of libraries | ||
| ported to the PS3 such as SDL and zlib. | ||
|
|
||
| Quitting from the XMB requires the application to register a callback to handle the event. An example using this is the camera example. |
There was a problem hiding this comment.
This information is rather important. Is the idea to put all the removed info into the wiki (which right now just links back to this README)?
There was a problem hiding this comment.
I think this particular line should be readded, it is important. Some core information like this can remain in the README - if you have any other suggestions on this point, I'd appreciate them. Foundational points like callbacks are unlikely to change as PSL1GHT develops, so unlike the longer feature trivia, I think they're safe to include.
- 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
|
Made several changes based on the feedback so far. Let me know if anything else needs to be done. |
|
LGTM. |
3 participants
README has not been updated in years - it's stale by now. For example @bucanero you may confirm if the Python requirement mentioned here is outdated, given you've worked on new scripts to replace it recently.
Rather than just commit this one edit, I opened this as a PR to review it and so we can then cleanly update it in one squashed merge.