Added doc section explaining the script and my plans for it

This commit is contained in:
Tristan Ancelet 2023-12-01 12:45:01 -06:00
parent dd157e834c
commit 6806beb733

View File

@ -1,5 +1,47 @@
#!/usr/bin/bash
######################################################################################
# install-discord-linux.sh #
######################################################################################
# #
# This script was created to automate the install of discord on your system. #
# It installs it separately from a package manager (snap, apt, dnf, etc), so this #
# can be used to install it on any linux system regardless of distro #
# as long as the OS & processor supports it. #
# #
# This script was originally just setup to handle installing or updating the #
# existing installation. It can be setup in crontab to handle it automatically so #
# you never have to manually do it again. All you have to do is add it to your #
# crontab to run daily or hourly (assuming you have a cron service installed) #
# #
# EX: #
# """ #
# CRONTAB="$(crontab -l)" #
# if [[ $? -eq 0 ]]; then #
# CRONTAB+="\n0 0 * * * /path/to/script.sh" #
# echo -e "$CRONTAB" | crontab - #
# else #
# echo "0 0 * * * /path/to/script.sh" | crontab - #
# fi #
# """ #
# #
# eventually I am wanting this script to also provide additional functionalities: #
# - Install BetterDiscord #
# - Handle multiple installations of discord (makes named config directories #
# and will symlink them based on what "profile" you want to use). This will also #
# allow you to have a installation that contains mods and others without. #
# - Handle manual configurations of discord (where applicable) #
# #
######################################################################################
# Dependencies # #
################ #
# #
# 1) wget #
# 2) bash (of course) #
# #
######################################################################################
# BEGIN: Variables
DEBUG=1