Updated README.

This commit is contained in:
Felix 2013-03-17 23:40:54 +01:00
parent 1825251b28
commit e1afb5a9af

View File

@ -2,12 +2,16 @@ uOFW
====
The unofficial Official FirmWare, a complete latest PSP firmware reverse engineering project.
Project page: http://uofw.psnpt.com/
Doxygen documentation: http://uofw.psnpt.com/sdkdoc/
For more information: http://dev.psnpt.com/redmine/projects/uofw/wiki
Getting started
---------------
NOTE: We currently plan to move both the wiki and the documentation to Github and shutdown the project page
instead. We'll keep you updated on this as progress is being made.
## Getting started
In order to contribute to uOFW, you need advanced knowledge in MIPS ASM and C. Some good MIPS ASM
online resources can be found at:
@ -24,8 +28,21 @@ http://psnpt.com/joomla/index.php/articles/39-tutorials
If you have questions, don't hesitate to ask us!
Additional Information
----------------------
## Repository structure
uOFW's Github repository contains 'master' branch and several sub-branches.
The master branch is aimed to contain only tested and working code (in fact, it should contain working modules).
Please note that this is not entirely the case right now as we still need to test, and fix, some of the code in the
master branch due to the past repository structure.
Then there are sub-branches which are aimed to each represent a module currently being worked on. Such a branch
contains unfinished, untested and undocumented code about the module it is named after. Once such a branch contains
finished, documented code (that is, the module has been finished reverse-engineering) it will be merged into
the 'master' branch.
## Additional Information
While you reverse-engineer parts of the PSP's kernel, you may will find yourself in a position
where you would like to know more about how Operating Systems work in general. We suggest to check
@ -34,23 +51,23 @@ out the following webpage: http://wiki.osdev.org/Expanded_Main_Page
If you are looking for more PSP-related resources, you should consider checking out the following links
below:
- http://lan.st/archive/index.php/t-151.html (LAN.st - IdStorage)
- http://lan.st/archive/index.php/t-3013.html (LAN.st - General PSP questions)
- http://lan.st/archive/index.php/t-372.html (LAN.st - PSP Motherboard information)
* [LAN.st - IdStorage](http://lan.st/archive/index.php/t-151.html)
* [LAN.st - General PSP questions](http://lan.st/archive/index.php/t-3013.html)
* [LAN.st - PSP Motherboard information](http://lan.st/archive/index.php/t-372.html)
- http://hitmen.c02.at/files/yapspd/psp_doc.pdf.tar.gz (Yet Another laystation Portable Documentation)
- http://pspdev1.com/wp-content/uploads/2007/03/moduletutorialv1.pdf (PSP Module Tutorial)
- https://www.youtube.com/watch?v=INdUZk4NFIA (24C3 - TyRaNiD on early PSP hacking + Pandorra hack)
* [Yet Another laystation Portable Documentation](http://hitmen.c02.at/files/yapspd/psp_doc.pdf.tar.gz)
* [PSP Module Tutorial](http://pspdev1.com/wp-content/uploads/2007/03/moduletutorialv1.pdf)
* [24C3 - TyRaNiD on early PSP hacking + Pandorra hack](https://www.youtube.com/watch?v=INdUZk4NFIA)
Other websites are:
- http://wololo.net
- http://ps2dev.org
* http://wololo.net
* http://ps2dev.org
Contact
-------
You can stay in touch with us and discuss project-related topics with us via the following ways:
- via IRC on the FreeNode server (irc.freenode.net) (join the channel #uofw)
- via e-mail
* via IRC on the FreeNode server (irc.freenode.net) (join the channel #uofw)
* via e-mail