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-10 12:06:50 +01:00
parent 2cae941eea
commit ebc4809ef3
1 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,6 +1,6 @@
# Helium Bowser installer & updater
## Purpose
This script was initially designed to just update my Helium browser but over time and interest it got more functional and universal. It includes functions to install, update, remove, add launcher, etc... and is distro independent.
This script was initially designed to just update my Helium browser but over time and interest it got more functional and universal. It includes functions to install, update, remove, add launcher, etc... It's supposed to run in user space and is (Linux) distro independent I suppose.
With "little" tinkering it should be possible to apply this script to install, update & configure many kinds of releases from source, like Debian packages, AppImages, binaries, etc...
## Usage
@ -15,21 +15,20 @@ To initally install Helium browser via this script, download helium_helper.sh an
wget https://lab.c95.org/fr4nz/helium-helper/raw/branch/main/helium_helper.sh && chmod +x helium_helper.sh
```
Run script with install parameter _-i_
- Default install directory = `$HOME/.apps/Helium`
```sh
./helium_helper.sh -i
```
OPTIONAL : Add alias to `.shellrc` | _working in zsh, bash & fish_
- Default alias = _update-helium_
**OPTIONAL** : Add alias to `.shellrc` | _working in zsh, bash & fish_
- Default alias = `update-helium`
```sh
./helium_helper.sh -a
```
- Custom alias
```sh
./helium_helper.sh -a <ALIAS>
```
---
### Updating
**From launcher** (if added)
**From launcher** (if added during install or by running `./helium_helper.sh -l`)
Checking for the latest version and updating can simply be done for the browser as well as the script by right clicking the app icon and choosing either update option, which will be run by `helium_launcher_update.sh`. This will backup all files that are being updated and write a log.
@ -46,8 +45,8 @@ Updating can also be done by running:
```
---
### 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
Backing up, by default, pulls all important files, folders & configuration and compresses an archive, which is stored in `$HOME/.apps/Helium/assets`
- Default backup
```sh
./helium_helper.sh -b
```
@ -55,13 +54,15 @@ Backing up pulls all important files, folders & configuration and compresses an
```sh
./helium_helper.sh -b </PATH/TO/DESTINATION>
```
Since this script is interactive, it doesn't keep logs.
**NOTE:** The backup path specified won't be overridden within the script yet. Working on it...
**Since this script is interactive, it doesn't keep logs.**
## Overview
### Helium_Helper.sh
- Interactive installer, updater & configuration script
- Installs to `$HOME/.apps/Helium` | changeable in line 31 `INSTALL_PATH`
- Installs to `$HOME/.apps/Helium` | changeable in line 32 `INSTALL_PATH`
- Assumes:
- Presence of `$HOME/.apps/Helium` when updating | changeable in line 31 `INSTALL_PATH`
- Presence of `$HOME/.apps/Helium` when updating | changeable in line 32 `INSTALL_PATH`
- Executable named `Helium.AppImage`
- Keeps backup archives from
- `Helium.AppImage`