Added sidebar, deteiled functions and porting page

Home.md

@@ -9,9 +9,9 @@ This script was initially designed to just update my Helium browser but over tim
     
 - Remove Helium
     
-- Add and update Desktop Launcher
+- Add and update Desktop Launcher with extra functionality
     
-- Add alias to `.shellrc`
+- Add alias to `.shellrc` --> _tested with bash and zsh_
     
 - Compare local and remote version
     
@@ -21,56 +21,40 @@ This script was initially designed to just update my Helium browser but over tim
     
 - Help
 
-## Functions in detail
+See [[detailed functions|detailed_functions]] for more information.
-### No parameter
-1.  Run dependency check for every "special" command needed for the script  
-    1\. **TRUE** | proceed  
-    2\. **FALSE** | tell what's missing && exit
-2.  Check for Helium folder & executable  
-    1\. **TRUE** | proceed  
-    2\. **FALSE** | tell what's missing && ask to install Helium or exit
-3.  Update Helium  
-    1\. See update process
-4.  Check for temporary directory, remove if present && exit
 
-### Install process
+## Usage
-1.  Check for Helium executable  
+get help
-    1\. **TRUE** | try to update helium  
+```sh
-    2\. **FALSE** | ask for install confirmation && proceed or exit
+./helium_helper.sh -h
-2.  Get latest download URL & file name with `curl`
+```
-3.  Download given file to `tmp` with `wget`
+### First Install
-4.  Make file executable `chmod`
+To initally install Helium browser via this script, download helium_helper.sh and make it executable:
-5.  Create app folder
+```sh
-6.  Move file to app folder
+wget https://lab.c95.org/fr4nz/helium-helper/raw/branch/main/helium_helper.sh && chmod +x helium_helper.sh
-7.  Ask to add launcher  
+```
-    1\. **TRUE** | run add launcher function && proceed  
+Run script with install parameter **-i**
-    2\. **FALSE** | proceed
+```sh
-8.  Check for temporary directory, remove if present && exit
+./helium_helper.sh -i
+```
+Add alias to `.shellrc` | _optional_
+```sh
+./helium_helper.sh -a   ### ONLY TESTED WITH zsh & bash
+```
+---
+### Updating
+**From launcher** (if added)
 
-### Update process
+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.
-1. Check local and remote version tags
-    1\. **TRUE** | proceed  
-    2\. **FALSE** | tell whats wrong && exit
-2. Compare local and remote version tags 
-    1\. **EQUAL** | tell okay && exit
-    2\. **GT** | show local and remote version && ask for confirmation && proceed or exit
-    3\. **ELSE** | show local and remote version && exit
-3. Create `tmp` & `backup` path
-4. Download file to `tmp` with `wget`
-5. Make file executable `chmod`
-6. Check for old backup and remove if existent
-7. Move outdated file to `backup`
-8. Move latest file to Helium folder
-9. Create `backup` of launcher
-10. Update Launcher (version number) `sed`
-11. Check for temporary directory, remove if present && exit
 
-### Removal process
+**Terminal**
-1. Check presence of Helium folder
-    1\. **TRUE** | ask for removal confirmation && proceed or exit  
-    2\. **FALSE** | tell && exit
-2. Remove Helium folder
-3. Remove launcher if present
-4. Remove alias if present
 
+Updating can also be done by running:
+```sh
+./helium_helper.sh -u   ### UPDATE APP
+```
+```sh
+./helium_helper.sh -S   ### UPDATE SCRIPT
+```
+Since this script is interactive, it doesn't keep logs.
  

_Sidebar.md

@@ -0,0 +1,3 @@
+1. [[Introduction|Home]]
+2. [[Functions in detail|detailed_functions]]
+3. [[Porting|porting]]

detailed_functions.md

@@ -0,0 +1,53 @@
+# Functions in detail
+## No parameter
+1.  Run dependency check for every "special" command needed for the script  
+    1\. **TRUE** | proceed  
+    2\. **FALSE** | tell what's missing && exit
+2.  Check for Helium folder & executable  
+    1\. **TRUE** | proceed  
+    2\. **FALSE** | tell what's missing && ask to install Helium or exit
+3.  Update Helium  
+    1\. See update process
+4.  Check for temporary directory, remove if present && exit
+
+## Install process
+1.  Check for Helium executable  
+    1\. **TRUE** | try to update helium  
+    2\. **FALSE** | ask for install confirmation && proceed or exit
+2.  Get latest download URL & file name with `curl`
+3.  Download given file to `tmp` with `wget`
+4.  Make file executable `chmod`
+5.  Create app folder
+6.  Move file to app folder
+7.  Ask to add launcher  
+    1\. **TRUE** | run add launcher function && proceed  
+    2\. **FALSE** | proceed
+8.  Check for temporary directory, remove if present && exit
+
+## Update process
+1. Check local and remote version tags
+    1\. **TRUE** | proceed  
+    2\. **FALSE** | tell whats wrong && exit
+2. Compare local and remote version tags 
+    1\. **EQUAL** | tell okay && exit
+    2\. **GT** | show local and remote version && ask for confirmation && proceed or exit
+    3\. **ELSE** | show local and remote version && exit
+3. Create `tmp` & `backup` path
+4. Download file to `tmp` with `wget`
+5. Make file executable `chmod`
+6. Check for old backup and remove if existent
+7. Move outdated file to `backup`
+8. Move latest file to Helium folder
+9. Create `backup` of launcher
+10. Update Launcher (version number) `sed`
+11. Check for temporary directory, remove if present && exit
+
+## Removal process
+1. Check presence of Helium folder
+    1\. **TRUE** | ask for removal confirmation && proceed or exit  
+    2\. **FALSE** | tell && exit
+2. Remove Helium folder
+3. Remove launcher if present
+4. Remove alias if present
+
+ 

porting.md

@@ -0,0 +1,2 @@
+# Porting this script
+TBC...