Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
GloriousEggroll committed Feb 27, 2024
1 parent 08ab8a6 commit 809c32d
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,12 +88,15 @@ Resulting 'reaper' executable will be inside builddir folder.

ULWGL entire folder should be placed at /usr/share/ULWGL

A symlink for ulwgl-run should be placed at /usr/bin/ulwgl-run, symlinking to /usr/share/ULWGL/ulwgl_run.py:

`ln -s /usr/share/ULWGL/ulwgl_run.py /usr/bin/ulwgl-run`
Copy ulwgl-run to /usr/bin/ulwgl-run

For the flatpak version, the folders will be /app/share and /app/bin respectively.

TODO:

We are working on a build script to allow custom INSTALL_PATH so that /usr/share and/or /app/share are not hard-coded required values. The build script will also provide a compiled copy of reaper.


# Usage notes:

When /usr/bin/ulwgl-run is first run, it will copy the /usr/share/ULWGL folder to ~/.local/share/ULWGL. From that point on the ~/.local/share/ULWGL folder will be used for running ulwgl. It will also perform a version check to make sure that if the contents of /usr/share/ULWGL are updated, that the local version also gets updated.
Expand Down

0 comments on commit 809c32d

Please sign in to comment.