Readme updated

This commit is contained in:
Fr4nz D13trich 2026-01-09 00:10:56 +01:00
parent 6c91e896bc
commit 90dd1ea68b

View file

@ -17,9 +17,14 @@ Run script with install parameter _-i_
```sh ```sh
./helium_helper.sh -i ./helium_helper.sh -i
``` ```
Add alias to `.shellrc` | _optional_ OPTIONAL : Add alias to `.shellrc` | _working in zsh, bash & fish_
- Default alias
```sh ```sh
./helium_helper.sh -a ### ONLY TESTED WITH zsh & bash ./helium_helper.sh -a
```
- Custom alias
```sh
./helium_helper.sh -a <ALIAS>
``` ```
--- ---
### Updating ### Updating
@ -30,27 +35,40 @@ Checking for the latest version and updating can simply be done for the browser
**Terminal** **Terminal**
Updating can also be done by running: Updating can also be done by running:
- Update Helium Browser
```sh ```sh
./helium_helper.sh -u ### UPDATE APP ./helium_helper.sh -u
``` ```
- Update Helium Helper
```sh ```sh
./helium_helper.sh -S ### UPDATE SCRIPT ./helium_helper.sh -S
```
### Backing up
Backing up pulls all important files, folders & configuration and compresses an archive. By default it will be stored in `$HOME/.apps/Helium/assets`
- Backup to default path
```sh
./helium_helper.sh -b
```
- Backup to custom path
```sh
./helium_helper.sh -b </PATH/TO/DESTINATION>
``` ```
Since this script is interactive, it doesn't keep logs. Since this script is interactive, it doesn't keep logs.
## Overview ## Overview
### Helium_Helper.sh ### Helium_Helper.sh
- Interactive installer, updater & configuration script - Interactive installer, updater & configuration script
- Installs to `/home/<USER>/.apps/Helium` | changeable in line 28 `INSTALL_PATH` - Installs to `$HOME/.apps/Helium` | changeable in line 31 `INSTALL_PATH`
- Assumes: - Assumes:
- Presence of `/home/<USER>/.apps/Helium` when updating | changeable in line 28 `INSTALL_PATH` - Presence of `$HOME/.apps/Helium` when updating | changeable in line 31 `INSTALL_PATH`
- Executable named `Helium.AppImage` - Executable named `Helium.AppImage`
- Keeps backups of - Keeps backup archives from
- `Helium.AppImage` --> `Helium.AppImage.old` - `Helium.AppImage`
- `helium_helper.sh` --> `helium_helper.sh.old` - `helium_helper.sh`
- `helium_launcher_update.sh` --> `helium_launcher_update.sh.old` - `helium_launcher_update.sh`
- `Helium.desktop` --> `Helium.desktop.old` - `Helium.desktop`
which will be overwritten at every update - `net.imput.helium`
- Adds desktop launcher to `/home/<USER>/.local/share/applications` - Adds desktop launcher to `$HOME/.local/share/applications`
- Adds options to launcher which are run by `helium_launcher_updater.sh` - Adds options to launcher which are run by `helium_launcher_updater.sh`
- Update Helium - Update Helium
- Update Script - Update Script
@ -60,14 +78,14 @@ Since this script is interactive, it doesn't keep logs.
### Helium_Launcher_Update.sh ### Helium_Launcher_Update.sh
- Update Helium from launcher - Update Helium from launcher
- Assumes: - Assumes:
- Presence of `/home/<USER>/.apps/Helium` when updating | changeable in line 19 `INSTALL_PATH` - Presence of `$HOME/.apps/Helium` when updating | changeable in line 21 `INSTALL_PATH`
- Executable named `Helium.AppImage` - Executable named `Helium.AppImage`
- Loggs to `/home/<USER>/.apps/Helium/assets/logs` - Loggs to `$HOME/.apps/Helium/assets/logs`
- Keeps backups of - Keeps backup archives from
- `Helium.AppImage` --> `Helium.AppImage.old` - `Helium.AppImage`
- `helium_helper.sh` --> `helium_helper.sh.old` - `helium_helper.sh`
- `helium_launcher_update.sh` --> `helium_launcher_update.sh.old` - `helium_launcher_update.sh`
- `Helium.desktop` --> `Helium.desktop.old` - `Helium.desktop`
which will be overwritten at every update - `net.imput.helium`
- Run `helium_launcher_update.sh -h` for help - Run `helium_launcher_update.sh -h` for help
&nbsp; &nbsp;