External/pspsdk
1
0
Fork 0
mirror of https://github.com/pspdev/pspsdk.git synced 2025-10-03 08:41:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Diamond Rivero
2023-11-27 16:32:23 +08:00
parent ebc0edbc25
commit 7c6f222300
1 changed files with 33 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
README.md
View File

@@ -59,100 +59,69 @@ build.mak is used.
## Installation
PSPSDK is distributed in both source and docker image. If you only want to
use the PSPSDK tools and libraries to develop your software you'll want to grab
the docker image distribution of PSPSDK. If you
need fine-grained control over how PSPSDK is installed on your system, or if you
use the PSPSDK tools and libraries to develop your software you'll want to pull
the docker image distribution of PSPSDK using https://github.com/pspdev/pspsdk/pkgs/container/pspsdk. If you need fine-grained control over how PSPSDK is installed on your system, or if you
would like to modify PSPSDK then grab the source distribution.
### Requirements
To use PSPSDK you must have the following software installed:
* **PSPDEV Toolchain** - PSPSDK requires the GNU toolchain (GCC and binutils) targetted to the PSP.
You can find binary packages of these tools at https://github.com/pspdev/.
You can find a script to build and install the toolchain at https://github.com/pspdev/psptoolchain.
* The PSPDEV Toolchain. PSPSDK requires the GNU toolchain (GCC and binutils)
targetted to the PSP. You can find binary packages of these tools at
https://github.com/pspdev/. You can find a script to build and install the
toolchain at https://github.com/pspdev/psptoolchain.
In addition to the above requirements, if you plan on building PSPSDK from
source, you will need:
* **GNU Make** - You can find GNU Make at http://www.gnu.org/software/make/.
* Make. Note: GNU Make may not be required, but if you run into problems
building from source you may want to install it. You can find GNU Make
at http://www.gnu.org/software/make/.
* **GNU autotools** - You will need a recent version of autoconf (http://www.gnu.org/software/autoconf/) and automake (http://sourceware.org/automake/).
* A Git client. Check https://git-scm.com/downloads how to install git
according to your system.
* GNU autotools. You will need a recent version of autoconf
(http://www.gnu.org/software/autoconf/) and automake
(http://sourceware.org/automake/).
The following packages are not required to build PSPSDK, but are used to build documentation and other optional resources:
The following packages are not required to build PSPSDK, but are used to build
documentation and other optional resources:
* **Doxygen** - You can find Doxygen at http://doxygen.nl/. If you want to view the pretty source dependency graphs,
then you will also need to install Graphviz (http://www.graphviz.org/).
* Doxygen. You can find Doxygen at http://doxygen.nl/.
If you want to view the pretty source dependency graphs, then you will also
need to install Graphviz (http://www.graphviz.org/).
### Installation from source
PSPSDK can be found in the Git repository located at
https://github.com/pspdev/pspsdk. If you are using the command line version of
the git client, you can do the following command to download PSPSDK:
https://github.com/pspdev/pspsdk. you can do the following command to download PSPSDK:
```
```bash
git clone https://github.com/pspdev/pspsdk.git
```
Once you've downloaded PSPSDK, run this command to create the configure script and support files.
Once you've downloaded PSPSDK, run the following command from the pspsdk directory to
create the configure script and support files (you must have autoconf and
automake installed):
```
cd pspsdk && ./bootstrap
```bash
./bootstrap
```
> **Note**
> PSPSDK uses the GNU autotools (autoconf and automake) for its build system.
PSPSDK uses the GNU autotools (autoconf and automake) for its build system. To
install PSPSDK, run the following commands:
This command will configure the system for the PSPSDK installation
```
```bash
./configure
```
This will build the PSPSDK using all available processor cores
```
make -j $(getconf _NPROCESSORS_ONLN)
```
This will build the PSPSDK documentation
```
make
make doxygen-doc
```
> **Note**
> If you haven't installed Doxygen or don't want to build the library documentation, you can skip this.
This will install the PSPSDK(Default installation path: `/usr/local/pspdev/`)
```
make install
```
> **Note**
> If you are on Windows, you can use WSL2 and follow this installation as is.
### Installation from Docker Image
If you want to develop apps and games for PSP without installing from the source
you can use Docker, see https://docs.docker.com/get-docker/ how to get started
according to your OS.
after you install the Docker, just run this command to download the docker image:
```
docker pull pspdev/pspdev:latest
```
when it successfully downloaded, run this command to get
started(It will use your WSL2 env):
```
docker run -it pspdev/pspdev:latest
```
and after that you will see the `/ #`, meaning you are in the terminal and you are good to go.
> If you haven't installed Doxygen or don't want to build the library
documentation, you can skip the `make doxygen-doc` command.
## Notes