Skip to content

Commit a5878bc

Browse files
diamant3diamant3
authored
Merge pull request #43 from pspdev/split-up-installation-pages
Split up installation pages
2 parents ab9aa5a + e4fa178 commit a5878bc

File tree

8 files changed

+246
-145
lines changed

8 files changed

+246
-145
lines changed

‎index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An open source toolchain for PlayStation Portable (PSP) development. It allows y
1616
# Getting started
1717
{: .fs-6 .fw-700 }
1818

19-
Begin your journey [here](quickstart.html).
19+
Begin your journey [here](installation.html).
2020
{: .fs-5 }
2121

2222
Need some in-depth knowledge? [Go here](documentation.html).

‎installation.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Installation
3+
layout: home
4+
nav_order: 2
5+
---
6+
7+
# Installation
8+
{: .fs-10 .fw-700 .text-center }
9+
10+
Pick the installation guide for your system:
11+
12+
- [Window](installation/windows.html)
13+
- [MacOS](installation/macos.html)
14+
- [Ubuntu/Debian](installation/ubuntu.html)
15+
- [Fedora](installation/fedora.html)
16+
- [Docker](installation/docker.html)

‎installation/docker.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Installation on Docker
3+
layout: home
4+
nav_exclude: true
5+
---
6+
7+
# Installation on Docker
8+
{: .fs-10 .fw-700 .text-center }
9+
10+
## Docker
11+
{: .fs-6 .fw-700 }
12+
13+
Docker can be used on almost every platform and offers and easy way to use the PSPDEV toolchain with very little setup.
14+
15+
To use it, instatll Docker itself using the instructions [here](https://docs.docker.com/engine/install/).
16+
17+
### Toolchain
18+
{: .fs-6 .fw-700 }
19+
20+
Once docker is installed, the PSPDEV image can be downloaded using the following command from a terminal:
21+
22+
```shell
23+
docker pull pspdev/pspdev:latest
24+
```
25+
26+
To work with it, open a terminal in the directory with the code you'd like to build in it and run the following command:
27+
28+
```shell
29+
docker run -ti -v .:/source pspdev/pspdev:latest
30+
```
31+
32+
After that you can run `cd /source` to navigate to the code.
33+
34+
That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [Basic Programs](../basic_programs.html) page to for examples on what you can do with it.

‎installation/fedora.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Installation on Fedora
3+
layout: home
4+
nav_exclude: true
5+
---
6+
7+
# Installation on Fedora
8+
{: .fs-10 .fw-700 .text-center }
9+
10+
## Dependencies
11+
{: .fs-6 .fw-700 }
12+
13+
The PSPDEV toolchain requires a couple of dependencies to be installed before use. To install them, run the following command from a terminal:
14+
15+
```shell
16+
sudo dnf -y install @development-tools cmake bsdtar libusb-compat-0.1 gpgme fakeroot xz nano
17+
```
18+
19+
### Toolchain
20+
{: .fs-6 .fw-700 }
21+
22+
Installing the PSPDEV toolchain itself can be done with the following steps:
23+
24+
1. Download [the latest version of the toolchain here](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-fedora-latest.tar.gz).
25+
2. Extract the downloaded archive into your home directory, resulting in `/home/YOURUSERNAME/pspdev` being created.
26+
3. To make the toolchain usable, some environment variables need to be set. The first step in doing so it to open the `~/.bashrc` file with the `nano` text editor using the following command from a terminal:
27+
```shell
28+
nano ~/.bashrc
29+
```
30+
4. Add the following lines at the bottom of the file in the text editor:
31+
```shell
32+
export PSPDEV="~/pspdev"
33+
export PATH="$PATH:$PSPDEV/bin"
34+
```
35+
5. Now save and exit by pressing `Ctrl`+`X`, then `Y` and then enter/return.
36+
6. Close the current terminal and open a new one.
37+
7. From the new terminal, run the following command to confirm everything is set up correctly:
38+
```shell
39+
psp-config --pspdev-path
40+
```
41+
42+
That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [Basic Programs](../basic_programs.html) page to for examples on what you can do with it.

‎installation/macos.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Installation on MacOS
3+
layout: home
4+
nav_exclude: true
5+
---
6+
7+
# Installation on MacOS
8+
{: .fs-10 .fw-700 .text-center }
9+
10+
## Dependencies
11+
{: .fs-6 .fw-700 }
12+
13+
The PSPDEV toolchain requires a couple of dependencies to be installed before use. Installing them can be done using [brew](https://brew.sh/).
14+
15+
Once brew is installed, run the following command from a terminal to install the dependencies:
16+
17+
```shell
18+
brew install cmake pkgconf gnu-sed bash openssl libtool libarchive gettext texinfo bison flex isl gsl gmp mpfr
19+
```
20+
21+
### Toolchain
22+
{: .fs-6 .fw-700 }
23+
24+
Installing the PSPDEV toolchain itself can be done with the following steps:
25+
26+
1. Download the latest version of the toolchain for your system here:
27+
- [arm64](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-macos-latest-arm64.tar.gz) for M1 or newer CPUs.
28+
- [x86_64](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-macos-13-x86_64.tar.gz) for Intel CPUs.
29+
2. Extract the downloaded archive into your home directory, resulting in `/home/YOURUSERNAME/pspdev` being created.
30+
3. To make the toolchain usable, some environment variables need to be set. The first step in doing so it to open the `~/.zprofile` file with the `pico` text editor using the following command from a terminal:
31+
```shell
32+
pico ~/.zprofile
33+
```
34+
4. Add the following lines at the bottom of the file in the text editor:
35+
```shell
36+
export PSPDEV="~/pspdev"
37+
export PATH="$PATH:$PSPDEV/bin"
38+
```
39+
5. Now save and exit by pressing `Ctrl`+`X`, then `Y` and then enter/return.
40+
6. Close the current terminal and open a new one.
41+
7. From the new terminal, run the following command to confirm everything is set up correctly:
42+
```shell
43+
psp-config --pspdev-path
44+
```
45+
46+
That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [Basic Programs](../basic_programs.html) page to for examples on what you can do with it.

‎installation/ubuntu.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Installation on Ubuntu/Debian
3+
layout: home
4+
nav_exclude: true
5+
---
6+
7+
# Installation on Ubuntu/Debian
8+
{: .fs-10 .fw-700 .text-center }
9+
10+
## Dependencies
11+
{: .fs-6 .fw-700 }
12+
13+
The PSPDEV toolchain requires a couple of dependencies to be installed before use. To install them, run the following command from a terminal:
14+
15+
```shell
16+
sudo apt-get update
17+
```
18+
19+
```shell
20+
sudo apt-get install build-essential cmake pkgconf libreadline8 libusb-0.1 libgpgme11 libarchive-tools fakeroot
21+
```
22+
23+
### Toolchain
24+
{: .fs-6 .fw-700 }
25+
26+
Installing the PSPDEV toolchain itself can be done with the following steps:
27+
28+
1. Download [the latest version of the toolchain here](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-ubuntu-latest-x86_64.tar.gz).
29+
2. Extract the downloaded archive into your home directory, resulting in `/home/YOURUSERNAME/pspdev` being created.
30+
3. To make the toolchain usable, some environment variables need to be set. The first step in doing so it to open the `~/.bashrc` file with the `nano` text editor using the following command from a terminal:
31+
```shell
32+
nano ~/.bashrc
33+
```
34+
4. Add the following lines at the bottom of the file in the text editor:
35+
```shell
36+
export PSPDEV="~/pspdev"
37+
export PATH="$PATH:$PSPDEV/bin"
38+
```
39+
5. Now save and exit by pressing `Ctrl`+`X`, then `Y` and then enter/return.
40+
6. Close the current terminal and open a new one.
41+
7. From the new terminal, run the following command to confirm everything is set up correctly:
42+
```shell
43+
psp-config --pspdev-path
44+
```
45+
46+
That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [Basic Programs](../basic_programs.html) page to for examples on what you can do with it.

‎installation/windows.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
title: Installation on Windows
3+
layout: home
4+
nav_exclude: true
5+
---
6+
7+
# Installation on Windows
8+
{: .fs-10 .fw-700 .text-center }
9+
10+
## Windows Subsystem for Linux (WSL)
11+
{: .fs-4 .fw-700 }
12+
13+
On Windows the PSPDEV toolchain is run on Ubuntu running on Microsoft's WSL. This is very easy to set up and will offer us the full power of Linux from a Windows machine.
14+
15+
To set up WSL with Ubuntu in it run the following commands in a Powershell window started as administrator (right click run as administrator on Powershell in the start menu):
16+
17+
```powershell
18+
wsl --install
19+
```
20+
21+
After this is done, Ubuntu can be selected from the start menu to open a terminal. This will be used for all commands going forward.
22+
23+
Files in Ubuntu can be accessed through a network share. In `This Computer` right click on the background and select `Map network drive`. Set the folder to `\\wsl$` to make it easily accessible.
24+
25+
## Dependencies
26+
{: .fs-6 .fw-700 }
27+
28+
The PSPDEV toolchain requires a couple of dependencies to be installed before use. To install them, run the following command from an Ubuntu terminal:
29+
30+
```shell
31+
sudo apt-get update
32+
```
33+
34+
```shell
35+
sudo apt-get install build-essential cmake pkgconf libreadline8 libusb-0.1 libgpgme11 libarchive-tools fakeroot
36+
```
37+
38+
### Toolchain
39+
{: .fs-6 .fw-700 }
40+
41+
Installing the PSPDEV toolchain itself can be done with the following steps:
42+
43+
1. Download [the latest version of the toolchain here](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-ubuntu-latest-x86_64.tar.gz).
44+
2. Extract the downloaded archive into your `\\wsl$\home\YOURUSERNAME\`, resulting in `\\wsl$\home\YOURUSERNAME\pspdev` being created. Replace `YOURUSERNAME` with the existing one. This can be done using
45+
3. To make the toolchain usable, some environment variables need to be set. The first step in doing so it to open the `~/.bashrc` file with the `nano` text editor using the following command from an Ubuntu terminal:
46+
```shell
47+
nano ~/.bashrc
48+
```
49+
4. Add the following lines at the bottom of the file in the text editor:
50+
```shell
51+
export PSPDEV="~/pspdev"
52+
export PATH="$PATH:$PSPDEV/bin"
53+
```
54+
5. Now save and exit by pressing `Ctrl`+`X`, then `Y` and then enter/return.
55+
6. Close the current Ubuntu terminal and open a new one.
56+
7. From the new Ubuntu terminal, run the following command to confirm everything is set up correctly:
57+
```shell
58+
psp-config --pspdev-path
59+
```
60+
61+
That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [Basic Programs](../basic_programs.html) page to for examples on what you can do with it.

0 commit comments

Comments
 (0)