Merge pull request #87 from pspdev/rebrand-to-sdk

sharkwouter · web-flow · commit 4e590f6f43bb · 2025-04-04T23:24:31.000+02:00
Improve searchability by partially rebranding
diff --git a/Gemfile b/Gemfile
@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-gem "jekyll"
-gem "just-the-docs"
+gem "jekyll" # static site generator used
+gem "just-the-docs" # Jekyll theme used
+gem "jekyll-seo-tags" # adds SEO metadata to improve search engine visibility
+gem "jekyll-github-metadata" # fetches repo data for use in Jekyll
+gem "jekyll-include-cache" # caches included files to speed up site gen or load
+gem "jekyll-sitemap" # generate sitemap to help search engines index the site
diff --git a/_config.yml b/_config.yml
@@ -1,6 +1,7 @@
 title: PSPDEV
-description: "Development tools for the Playstation Portable"
+description: "An open source SDK for PlayStation Portable (PSP) development. It allows you to make apps and games for both custom and official firmwares. This is a community project made by enthusiasts, it is in no way affiliated with Sony."
 theme: just-the-docs
+url: "https://pspdev.github.io"
 
 # just-the-docs configuration
 favicon_ico: /images/pspdev.ico
@@ -17,3 +18,21 @@ nav_external_links:
   - title: "PSPDEV's package index"
     url: "https://pspdev.github.io/psp-packages/"
     opens_in_new_tab: true
+
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: 'Copyright &copy; 2025, PSPDEV. Distributed by <a href="https://github.com/pspdev/pspdev.github.io/blob/master/LICENSE">The Unlicense.</a>'
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: "Edit this page on GitHub"
+gh_edit_repository: "https://github.com/pspdev/pspdev.github.io" # the github URL for your repo
+gh_edit_branch: "master" # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+plugins:
+  - jekyll-seo-tag
+  - jekyll-github-metadata
+  - jekyll-sitemap
diff --git a/_includes/head.html b/_includes/head.html
@@ -0,0 +1,30 @@
+<head>
+  <meta charset="UTF-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=Edge">
+
+  <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
+  <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-head-nav.css' | relative_url }}" id="jtd-head-nav-stylesheet">
+
+  <style id="jtd-nav-activation">
+    {% include css/activation.scss.liquid %}
+  </style>
+
+  {% if site.search_enabled != false %}
+    <script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
+  {% endif %}
+
+  <script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>{{ page.title }} | PSP SDK: Development tools for the Playstation Portable</title>
+
+  <!-- Uncomment to conditionally change the <title> content  -->
+  <!-- {% if page.title == "Home" %}
+    <title>{{ page.title }} | PSP SDK: Development tools for the Playstation Portable</title>
+  {% endif %}
+
+  {% if page.title != "Home" %}
+    <title>{{ page.title }} | {{ site.title }}</title>
+  {% endif %} -->
+
+  {% seo title=false %}
+</head>
diff --git a/basic_programs.md b/basic_programs.md
@@ -379,7 +379,7 @@ Documentation for SDL2_ttf can be found <a href="https://wiki.libsdl.org/SDL2_tt
 ## More Examples
 {: .fs-6 .fw-700 }
 
-More examples on how to use specific functions offered in the PSPDEV toolchain can be found [here](https://github.com/pspdev/pspsdk/tree/master/src/samples). Additional documentation on these functions can be found [here](https://pspdev.github.io/pspsdk/).
+More examples on how to use specific functions offered in the PSP SDK can be found [here](https://github.com/pspdev/pspsdk/tree/master/src/samples). Additional documentation on these functions can be found [here](https://pspdev.github.io/pspsdk/).
 
 ## Debugging
 {: .fs-6 .fw-700 }
diff --git a/contributing.md b/contributing.md
@@ -24,7 +24,7 @@ Pull requests are always welcome!
 ## Where can I find the code?
 {: .fs-6 .fw-700 }
 
-The PSPDEV toolchain is build using quite a few different repositories which each add their own piece to the system. If you just want to build everything at once, the [pspdev repository](https://github.com/pspdev/pspdev) is the place to go.
+The PSP SDK is build using quite a few different repositories which each add their own piece to the system. If you just want to build everything at once, the [pspdev repository](https://github.com/pspdev/pspdev) is the place to go.
 
 There are automated builds, which build each part individually if there are changes. Here is a basic image showing the build order:
 
diff --git a/debugging.md b/debugging.md
@@ -81,7 +81,7 @@ The information received from `psp-addr2line` will be limited and not always use
 ## Using a Debugger
 {: .fs-6 .fw-700 }
 
-When using `psp-addr2line` is not enough to figure out what is going on, the best way to debug will be by using an actual debugger called GDB, which comes bundled with the PSPDEV toolchain as the `psp-gdb` command. PSPLINK allows this debugger to connect directly to the PSP.
+When using `psp-addr2line` is not enough to figure out what is going on, the best way to debug will be by using an actual debugger called GDB, which comes bundled with the PSP SDK as the `psp-gdb` command. PSPLINK allows this debugger to connect directly to the PSP.
 
 ### Preparation
 {: .fs-4 .fw-700 }
diff --git a/downloads.md b/downloads.md
@@ -7,7 +7,7 @@ nav_order: 7
 # Downloads
 {: .fs-8 .fw-700 .text-center }
 
-Download the latest update for the PSPDEV toolchain here. If you don't have it setup yet, go to the [installation instructions](installation.html) instead! Otherwise click on the link for your system:
+Download the latest update for the PSP SDK here. If you don't have it setup yet, go to the [installation instructions](installation.html) instead! Otherwise click on the link for your system:
 
 - [Windows/Ubuntu/Debian](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-ubuntu-latest-x86_64.tar.gz)
 - [MacOS (arm64)](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-macos-latest-arm64.tar.gz)
diff --git a/how_to_use.md b/how_to_use.md
@@ -7,7 +7,7 @@ nav_order: 3
 # How to use
 {: .fs-8 .fw-700 .text-center }
 
-This page will describe how to use the PSPDEV toolchain to build a basic program for the Playstation Portable (PSP), including screenshots. The screenshots will mainly be for Windows users, but the steps will not be much different for other operating systems, so you should be able to follow along.
+This page will describe how to use the PSP SDK to build a basic program for the Playstation Portable (PSP), including screenshots. The screenshots will mainly be for Windows users, but the steps will not be much different for other operating systems, so you should be able to follow along.
 
 Before going through this guide, make sure to have followed the [installation instructions](installation.html) first.
 
@@ -67,7 +67,7 @@ For building, a terminal is used with a couple of short commands. To open a term
 
 ![](images/vscode-open-terminal.png)
 
-This will open a terminal at the bottom of the screen. On Windows, this will be a powershell window, but the PSPDEV toolchain is installed in WSL. To open a WSL terminal instead, click on the arrow next to the `+` sign at the right side an select `Ubuntu (WSL)`:
+This will open a terminal at the bottom of the screen. On Windows, this will be a powershell window, but the PSP SDK is installed in WSL. To open a WSL terminal instead, click on the arrow next to the `+` sign at the right side an select `Ubuntu (WSL)`:
 
 ![](images/vscode-ubuntu-shell.png)
 
diff --git a/index.md b/index.md
@@ -7,22 +7,24 @@ nav_order: 1
 <center><img src="images/pspdev.ico" width="64px" /></center>
 
 # Welcome to PSPDEV
-{: .fs-8 .fw-700 .text-center }
+{: .fs-8 .fw-700 .text-center .lh-0 }
 
+# The PSP SDK for Homebrew
+{: .fs-6 .fw-700 .text-center }
 
-An open source toolchain for PlayStation Portable (PSP) development. It allows you to make apps and games for both custom and official firmwares. **This is a community project made by enthusiasts, it is in no way affiliated with Sony**.
+An open source SDK for PlayStation Portable (PSP) development. It allows you to make apps and games for both custom and official firmwares. **This is a community project made by enthusiasts, it is in no way affiliated with Sony**.
 {: .fs-5 .text-center }
 
 # Getting started
 {: .fs-6 .fw-700 }
 
-Want to install the PSPDEV toolchain? [Go here](installation.html).
+Want to install the PSP SDK? [Go here](installation.html).
 {: .fs-5 }
 
 Don't know how to get started? [Go here](how_to_use.html).
 {: .fs-5 }
 
-Need some examples for what you can do with the PSPDEV toolchain? [Go here](basic_programs.html).
+Need some examples for what you can do with the PSP SDK? [Go here](basic_programs.html).
 {: .fs-5 }
 
 Is your code is not working? [Go here](debugging.html).
diff --git a/installation/docker.md b/installation/docker.md
@@ -10,7 +10,7 @@ nav_exclude: true
 ## Docker
 {: .fs-6 .fw-700 }
 
-Docker can be used on almost every platform and offers and easy way to use the PSPDEV toolchain with very little setup.
+Docker can be used on almost every platform and offers and easy way to use the PSP SDK with very little setup.
 
 To use it, install Docker itself using the instructions [here](https://docs.docker.com/engine/install/).
 
@@ -31,4 +31,4 @@ docker run -ti -v .:/source pspdev/pspdev:latest
 
 After that you can run `cd /source` to navigate to the code.
 
-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.
+That's it, now the PSP SDK 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.
diff --git a/installation/fedora.md b/installation/fedora.md
@@ -10,7 +10,7 @@ nav_exclude: true
 ## Dependencies
 {: .fs-6 .fw-700 }
 
-The PSPDEV toolchain requires a couple of dependencies to be installed before use. To install them, run the following command from a terminal:
+The PSP SDK requires a couple of dependencies to be installed before use. To install them, run the following command from a terminal:
 
 ```shell
 sudo dnf -y install @development-tools cmake bsdtar libusb-compat-0.1 gpgme fakeroot xz nano
@@ -19,7 +19,7 @@ sudo dnf -y install @development-tools cmake bsdtar libusb-compat-0.1 gpgme fake
 ## Toolchain 
 {: .fs-6 .fw-700 }
 
-Installing the PSPDEV toolchain itself can be done with the following steps:
+Installing the PSP SDK itself can be done with the following steps:
 
 1. Download [the latest version of the toolchain here](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-fedora-latest.tar.gz).
 2. Extract the downloaded archive into your home directory, resulting in `/home/YOURUSERNAME/pspdev` being created.
@@ -39,4 +39,4 @@ Installing the PSPDEV toolchain itself can be done with the following steps:
     psp-config --pspdev-path
     ```
 
-That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
+That's it, now the PSP SDK can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
diff --git a/installation/macos.md b/installation/macos.md
@@ -10,7 +10,7 @@ nav_exclude: true
 ## Dependencies
 {: .fs-6 .fw-700 }
 
-The PSPDEV toolchain requires a couple of dependencies to be installed before use. Installing them can be done using [brew](https://brew.sh/).
+The PSP SDK requires a couple of dependencies to be installed before use. Installing them can be done using [brew](https://brew.sh/).
 
 Once brew is installed, run the following command from a terminal to install the dependencies:
 
@@ -21,7 +21,7 @@ brew install cmake pkgconf gnu-sed bash openssl libtool libmpc libarchive gettex
 ## Toolchain 
 {: .fs-6 .fw-700 }
 
-Installing the PSPDEV toolchain itself can be done with the following steps:
+Installing the PSP SDK itself can be done with the following steps:
 
 1. Download the latest version of the toolchain for your system here:
     - [arm64](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-macos-latest-arm64.tar.gz) for M1 or newer CPUs.
@@ -47,4 +47,4 @@ Installing the PSPDEV toolchain itself can be done with the following steps:
     psp-config --pspdev-path
     ```
 
-That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
+That's it, now the PSP SDK can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
diff --git a/installation/ubuntu.md b/installation/ubuntu.md
@@ -10,7 +10,7 @@ nav_exclude: true
 ## Dependencies
 {: .fs-6 .fw-700 }
 
-The PSPDEV toolchain requires a couple of dependencies to be installed before use. To install them, run the following command from a terminal:
+The PSP SDK requires a couple of dependencies to be installed before use. To install them, run the following command from a terminal:
 
 ```shell
 sudo apt-get update
@@ -23,7 +23,7 @@ sudo apt-get install build-essential cmake pkgconf libreadline8 libusb-0.1 libgp
 ## Toolchain 
 {: .fs-6 .fw-700 }
 
-Installing the PSPDEV toolchain itself can be done with the following steps:
+Installing the PSP SDK itself can be done with the following steps:
 
 1. Download [the latest version of the toolchain here](https://github.com/pspdev/pspdev/releases/latest/download/pspdev-ubuntu-latest-x86_64.tar.gz).
 2. Extract the downloaded archive into your home directory, resulting in `/home/YOURUSERNAME/pspdev` being created.
@@ -43,4 +43,4 @@ Installing the PSPDEV toolchain itself can be done with the following steps:
     psp-config --pspdev-path
     ```
 
-That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
+That's it, now the PSP SDK can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
diff --git a/installation/windows.md b/installation/windows.md
@@ -10,7 +10,7 @@ nav_exclude: true
 ## Windows Subsystem for Linux (WSL)
 {: .fs-6 .fw-700 }
 
-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.
+On Windows the PSP SDK 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.
 
 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):
 
@@ -31,7 +31,7 @@ This can be useful when building a specific project.
 ## Dependencies
 {: .fs-6 .fw-700 }
 
-The PSPDEV toolchain requires a couple of dependencies to be installed before use. To install them, run the following command from an Ubuntu terminal:
+The PSP SDK requires a couple of dependencies to be installed before use. To install them, run the following command from an Ubuntu terminal:
 
 ```shell
 sudo apt-get update
@@ -44,7 +44,7 @@ sudo apt-get install build-essential cmake pkgconf libreadline8 libusb-0.1 libgp
 ## Toolchain 
 {: .fs-6 .fw-700 }
 
-Installing the PSPDEV toolchain itself can be done with the following steps:
+Installing the PSP SDK itself can be done with the following steps:
 
 1. In a fresh WSL Session download the Toolchain Archive using the following command:
     ```shell
@@ -69,6 +69,6 @@ Installing the PSPDEV toolchain itself can be done with the following steps:
     ```shell
     psp-config --pspdev-path
     ```
-    If everything is set up correctly, the path of the PSPDEV toolchain installation will be shown.
+    If everything is set up correctly, the path of the PSP SDK installation will be shown.
 
-That's it, now the PSPDEV toolchain can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
+That's it, now the PSP SDK can be used to build PSP software. Check out the [How to Use](../how_to_use.html) page for a guide on how to do so.
diff --git a/tips_tricks.md b/tips_tricks.md
@@ -12,7 +12,7 @@ Here some useful tips for developing for the PSP.
 ## Making Programs Work on Unmodded PSPs
 {: .fs-6 .fw-700 }
 
-The PSPDEV toolchain contains tools for making your program work on unmodded PSPs. This can be done by running psp-cmake with some additional commands when building like so:
+The PSP SDK contains tools for making your program work on unmodded PSPs. This can be done by running psp-cmake with some additional commands when building like so:
 
 ```shell
 mkdir build && cd build
@@ -43,7 +43,7 @@ This makes sure that the other systems supported by the program keeps working th
 ## Managing Libraries
 {: .fs-6 .fw-700 }
 
-There are many C and C++ libraries available within the PSPDEV toolchain and most of them will be installed by default. Libraries are where most of the updates within the toolchain happen and they can be updated manually without redownload the toolchain using `psp-pacman`.
+There are many C and C++ libraries available within the PSP SDK and most of them will be installed by default. Libraries are where most of the updates within the SDK happen and they can be updated manually without redownload the SDK using `psp-pacman`.
 
 Updating the libraries installed can be done with the following command:
 
@@ -68,9 +68,9 @@ psp-pacman -S library
 ## Managing Licenses
 {: .fs-6 .fw-700 }
 
-Every project made with the PSPDEV toolchain will import at least some libraries, each with their own license. Everything bundled is free to use, but some libraries will ask you to share their license with your project or in rare cases give users access to your code to respect their licenses. The `psp-create-license-directory` tool can be used to easily collect the licenses that apply to your project, so you can comply with them and ship them with your project.
+Every project made with the PSP SDK will import at least some libraries, each with their own license. Everything bundled is free to use, but some libraries will ask you to share their license with your project or in rare cases give users access to your code to respect their licenses. The `psp-create-license-directory` tool can be used to easily collect the licenses that apply to your project, so you can comply with them and ship them with your project.
 
-To create a directory with a copy of the licenses that are always used in project made with the PSPDEV toolchain use the following command:
+To create a directory with a copy of the licenses that are always used in project made with the PSP SDK use the following command:
 
 ```
 psp-create-license-directory
@@ -88,9 +88,9 @@ If you're not sure what the library you used is called exactly, you can use the
 psp-create-license-directory -l
 ```
 
-## Updating the Toolchain
+## Updating the PSP SDK
 {: .fs-6 .fw-700 }
 
-A new version of the PSPDEV toolchain is released at least once a month, so updating should be done regularly if you want to benefit from new features and bug fixes.
+A new version of the PSP SDK is released at least once a month, so updating should be done regularly if you want to benefit from new features and bug fixes.
 
-To update the toolchain, simply follow the installation instruction for your system on the [Installation](installation.html) page. Installing the dependencies can be skipped.
+To update the SDK, simply follow the installation instruction for your system on the [Installation](installation.html) page. Installing the dependencies can be skipped.
