Skip to content

Commit

Permalink
Update regular + devel flatpaks
Browse files Browse the repository at this point in the history
Notable Changes:
- Add dependencies to build docs to the devel flatpak
- Update doc building instructions to add the option of using the devel flatpak
- Update appdata file to take out Steam Deck
- Take extra dependencies from flatpak builds that are included as of org.kde.Runtime//6.8
  • Loading branch information
streetpea committed Dec 5, 2024
1 parent 699b4f6 commit 3d1f8df
Show file tree
Hide file tree
Showing 5 changed files with 251 additions and 153 deletions.
45 changes: 34 additions & 11 deletions docs/diy/builddocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,39 @@

This is for people who want to update the documentation of `chiaki-ng` and see the updates locally or if you are a regular user and are curious on how to do it. In most cases, just accessing the documentation via the site https://streetpea.github.io/chiaki-ng/ is best. If you want to access the documentation without internet access, instead of following this documentation, you should navigate to the print page (which displays the documentation in printable format). Then, Print->Save to pdf in your web browser and access the PDF freely offline.

## Installing Necessary Pre-requisites
## Installing Pre-requisites

1. Install pip3 on your computer, if it's not already installed (instructions vary depending on Operating System)
2. Install mkdocs and plugins used in chiaki-ng documentation
=== "Using Flatpak [Linux Only]"
1. Install the devel flatpak and sdk

``` bash
pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-print-site-plugin
```
```bash
flatpak install -y --user https://raw.githubusercontent.com/streetpea/chiaki-ng/main/scripts/flatpak/io.github.streetpea.Chiaki4deck-devel.flatpakref
```
2. Install the sdk

```bash
flatpak install -y --user org.kde.Sdk//6.8
```

3. Run the devel flatpak

```bash
flatpak run --devel --command=bash io.github.streetpea.Chiaki4deck-devel
```

=== "Using System"

1. Install pip3 on your computer, if it's not already installed (instructions vary depending on Operating System)

2. Install mkdocs and plugins used in chiaki-ng documentation

``` bash
pip3 install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-print-site-plugin
```

## Updating the Documentation

3. Get a local copy of the source code with:
1. Get a local copy of the source code with:

=== "HTTPS"

Expand All @@ -33,23 +56,23 @@
gh repo clone streetpea/chiaki-ng
```

4. Change into the source code directory in your terminal
2. Change into the source code directory in your terminal

5. Serve the documentation in a terminal while in your source code directory with:
3. Serve the documentation in a terminal while in your source code directory with:

``` bash
mkdocs serve
```

6. Open a web browser and access the documentation
4. Open a web browser and access the documentation

The above `mkdocs serve` command should output an address to access the documentation which by default is: http://127.0.0.1:8000 which is over localhost (only accessible locally). Go to this address to access the documentation.

!!! Tip "Documentation updates automatically"

If you leave the terminal tab where you ran `mkdocs serve` open, the docs will update automatically when your save your changes to the file. This way as you make changes you can check your changes at the given web site, displaying in the same way as it will when displayed as a static website on GitHub.

7. Make edits to the relevant markdown files in the `docs/` subfolder, and watch the changes display in realtime in your web browser when you save your file updates.
5. Make edits to the relevant markdown files in the `docs/` subfolder, and watch the changes display in realtime in your web browser when you save your file updates.

!!! Tip "Special Documentation Features"

Expand Down
3 changes: 2 additions & 1 deletion docs/updates/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ In order to update your already installed `chiaki-ng` to the newest version, eit

Small patch update:

- HDR support for MacOS and Windows
- Add Windows installer
- Increase stability of motion controls
- Add native webview for obtaining PSN tokens, making it possible to obtain the token easily in Steam OS game mode
Expand Down Expand Up @@ -401,7 +402,7 @@ Install update following [updating `chiaki-ng`](#updating-chiaki-ng).
- Creating a Custom Controller Profile (Great for tinkering, especially for updating the default profile to meet your needs exactly):
Make a custom controller profile using the [Creating Your Own Controller Profile](../setup/controlling.md#creating-your-own-controller-profile){target="_blank" rel="noopener"} section, taking special note of the [Special Button Mappings](../setup/controlling.md#special-button-mappings-you-need-to-assign-these-yourself){target="_blank" rel="noopener"} and [Using Steam Deck Controller Touchscreen in Your Custom Controller Profile](../setup/controlling.md#using-steam-deck-controller-touchscreen-in-your-custom-controller-profile){target="_blank" rel="noopener"}
Make a custom controller profile using the [Creating Your Own Controller Profile](../setup/controlling.md){target="_blank" rel="noopener"} section, taking special note of the [Special Button Mappings](../setup/controlling.md#special-button-mappings-you-need-to-assign-these-yourself){target="_blank" rel="noopener"} and [Using Steam Deck Controller Touchscreen in Your Custom Controller Profile](../setup/controlling.md#using-steam-deck-controller-touchscreen-in-your-custom-controller-profile){target="_blank" rel="noopener"}
[Approximate Time Estimate: 10-20 minutes depending on your experience with Steam Deck Controller Layouts]
Expand Down
2 changes: 1 addition & 1 deletion gui/io.github.streetpea.Chiaki4deck.appdata.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<id>io.github.streetpea.Chiaki4deck</id>
<launchable type="desktop-id">chiaking.desktop</launchable>
<name>chiaki-ng</name>
<summary>Free and Open Source Client for PlayStation Remote Play modified for Steam Deck</summary>
<summary>Free and Open Source Client for PlayStation Remote Play</summary>
<metadata_license>CC0-1.0</metadata_license>
<project_license>AGPL-3.0-only</project_license>
<developer_name>Street Pea</developer_name>
Expand Down
Loading

0 comments on commit 3d1f8df

Please sign in to comment.