Skip to content

Commit

Permalink
Update readme.md, bump version number.
Browse files Browse the repository at this point in the history
  • Loading branch information
ValShaped committed Jun 24, 2024
1 parent 0a626fd commit ee93022
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
31 changes: 19 additions & 12 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Important Note:
Rwfus v0.5.0.b1 is *only* rated for compatibility with SteamOS 3.5 (Beta, at the time of writing)
# Important Note: You'll probably want [Nix][nix-inst] instead.

Nix is a ridiculously powerful, declarative package manager that forces packages to play nice with each other. That includes the system glibc. [You can learn about nix here][nixtutor], and [you can check if your package is available here][nix-pkgs].

SteamOS 3.5 and above have a built-in overlay for the `/nix` directory, and Nix is designed to work with (effectively) immutable root filesystems, like those found on the Steam Deck. It's a purpose-built solution.

Rwfus is not tested with all packages in the SteamOS/Arch repositories, and many of them will install to locations not covered by the overlay. If you just need to install Yakuake, but don't want to unlock your Deck, this'll do the trick. If you're looking for anything more complex, I suggest Nix.

## Rwfus: Read-Write OverlayFS for your Steam Deck!
---
Expand All @@ -15,17 +20,11 @@ Directories covered in a default installation:

### * Jank warning

Due to the way Valve's firmware updates work, doing `pacman -S[y[y]]u` at any time will lead to complications when the next firmware update is installed. I highly advise avoiding `-Su`, `-Syu`, and `-Syyu` altogether on a Steam Deck with read-only rootfs. It may lead to bad behavior.

Rwfus is, right now, a proof of concept (hence the 0.x version number, and being written in Bash.)
I made it to install a couple user-mode packages (nano-syntax-highlighting and yakuake specifically.)
It is not production-ready software, and in using Rwfus, you accept that I am not liable if your Deck catches fire.

Rwfus will allow you to install *any* package, but not everything will let your Deck survive an update. In particular, `glibc` will crash your Deck after an update, requiring the SteamOS recovery image and some knowledge of Linux and/or Rwfus' internals to fix.
Due to the way Valve's firmware updates work, doing `pacman -S[y[y]]u` at any time will leave your system in a partially updated state. This may cause crashes, hangs, boot-loops, or other undesired behavior, and will be annoying to fix. If you run into this issue, you can disable the Rwfus service from the recovery console with `systemctl disable rwfusd.service`

### Installation:

1. Download the latest release from GitHub's [Releases][rel] page
1. Download the latest release from GitHub's [Releases][releases] page
2. `cd rwfus`
3. `./rwfus -i`

Expand All @@ -34,7 +33,7 @@ Then you're all set! Remember to periodically run `pacman -Sy` to update your re
### Usage:

```
Rwfus v0.5.0.b2
Rwfus v0.5.0
Carry Pacman across SteamOS updates!
USAGE:
Expand Down Expand Up @@ -85,4 +84,12 @@ OPTIONS:
> `rwfus --config ./rwfus.conf`: Use a config file called `rwfus.conf` when setting up Rwfus
[rel]: https://github.com/ValShaped/rwfus/releases
# Adding `rwfus` to your `$PATH`

To access the `rwfus` manager utility from anywhere, you may want to [add it to your PATH][archpath].

[releases]: https://github.com/ValShaped/rwfus/releases
[archpath]: https://wiki.archlinux.org/title/Environment_variables#Per_user
[nix-inst]: https://github.com/DeterminateSystems/nix-installer
[nix-pkgs]: https://search.nixos.org/packages
[nixtutor]: https://nix.dev/tutorials/
2 changes: 1 addition & 1 deletion rwfus_include/info.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
export Name="Rwfus"
export Description="Carry Pacman across SteamOS updates!"
export Repository="https://github.com/ValShaped/rwfus"
export Version="0.5.0.b4"
export Version="0.5.0"

0 comments on commit ee93022

Please sign in to comment.