fr4nz/helium-helper
fr4nz/helium-helper
1
0
Fork 0
Code Issues 2 Pull requests Projects 2 Releases 5 Packages Wiki Activity Actions

Readme updated

Browse source
This commit is contained in:
Fr4nz D13trich 2026-01-09 00:10:56 +01:00
parent 6c91e896bc
commit 90dd1ea68b
1 changed files with 39 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -17,9 +17,14 @@ Run script with install parameter _-i_
```sh
./helium_helper.sh -i
```
Add alias to `.shellrc` | _optional_
OPTIONAL : Add alias to `.shellrc` | _working in zsh, bash & fish_
- Default alias
```sh
./helium_helper.sh -a ### ONLY TESTED WITH zsh & bash
./helium_helper.sh -a
```
- Custom alias
```sh
./helium_helper.sh -a <ALIAS>
```
---
### Updating
@ -30,27 +35,40 @@ Checking for the latest version and updating can simply be done for the browser
**Terminal**
Updating can also be done by running:
- Update Helium Browser
```sh
./helium_helper.sh -u ### UPDATE APP
./helium_helper.sh -u
```
- Update Helium Helper
```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.
## Overview
### Helium_Helper.sh
- 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:
- 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`
- Keeps backups of
- `Helium.AppImage` --> `Helium.AppImage.old`
- `helium_helper.sh` --> `helium_helper.sh.old`
- `helium_launcher_update.sh` --> `helium_launcher_update.sh.old`
- `Helium.desktop` --> `Helium.desktop.old`
which will be overwritten at every update
- Adds desktop launcher to `/home/<USER>/.local/share/applications`
- Keeps backup archives from
- `Helium.AppImage`
- `helium_helper.sh`
- `helium_launcher_update.sh`
- `Helium.desktop`
- `net.imput.helium`
- Adds desktop launcher to `$HOME/.local/share/applications`
- Adds options to launcher which are run by `helium_launcher_updater.sh`
- Update Helium
- Update Script
@ -60,14 +78,14 @@ Since this script is interactive, it doesn't keep logs.
### Helium_Launcher_Update.sh
- Update Helium from launcher
- 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`
- Loggs to `/home/<USER>/.apps/Helium/assets/logs`
- Keeps backups of
- `Helium.AppImage` --> `Helium.AppImage.old`
- `helium_helper.sh` --> `helium_helper.sh.old`
- `helium_launcher_update.sh` --> `helium_launcher_update.sh.old`
- `Helium.desktop` --> `Helium.desktop.old`
which will be overwritten at every update
- Loggs to `$HOME/.apps/Helium/assets/logs`
- Keeps backup archives from
- `Helium.AppImage`
- `helium_helper.sh`
- `helium_launcher_update.sh`
- `Helium.desktop`
- `net.imput.helium`
- Run `helium_launcher_update.sh -h` for help
&nbsp;