mirror of
https://github.com/G2-Games/welcome.sh.git
synced 2025-04-19 21:42:53 -05:00
Update README.md
This commit is contained in:
parent
5c75716b5d
commit
857d4d9d4e
1 changed files with 31 additions and 19 deletions
50
README.md
50
README.md
|
@ -11,6 +11,7 @@ My goal with this script is to keep it simple, just a single line that gives use
|
||||||
- <span title="Please let me know of other things to support!">Works across many distros (update checking support)</span>
|
- <span title="Please let me know of other things to support!">Works across many distros (update checking support)</span>
|
||||||
- Clean and simple
|
- Clean and simple
|
||||||
- Customizable
|
- Customizable
|
||||||
|
- Easy to install and update
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
### Installing:
|
### Installing:
|
||||||
|
@ -35,19 +36,16 @@ zsh -c "$(wget -q https://raw.githubusercontent.com/G2-Games/welcome.sh/main/ins
|
||||||
|
|
||||||
It installs to `~/.welcome/welcome.sh`, and adds a line to the bottom of `~/.bashrc` or `~/.zshrc`
|
It installs to `~/.welcome/welcome.sh`, and adds a line to the bottom of `~/.bashrc` or `~/.zshrc`
|
||||||
|
|
||||||
Run again to uninstall. Uninstalling will remove it from both Bash and Zsh.
|
|
||||||
|
|
||||||
#### Manual Installation
|
#### Manual Installation
|
||||||
To use it, download `welcome.sh` and place it in your home directory. Then add `/home/$USER/welcome.sh` to your `.bashrc`.
|
To use it, download the latest `welcome.sh` from <a href="https://github.com/G2-Games/welcome.sh/releases">releases</a> and place it in your home directory. Then add `~/welcome.sh` to your `.bashrc`. It works without the config file, but you can also add that to your home directory for easier manual updates.
|
||||||
|
|
||||||
### Updating:
|
### Updating:
|
||||||
WIP
|
Run the script again to check for an update. If you have an older version it will prompt you.
|
||||||
|
|
||||||
Currently you can update by uninstalling and reinstalling, but this wipes all settings. I am working on making a better way to do this.
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
### Configs:
|
### Configs:
|
||||||
To configure settings, open `welcome.sh` in your text editor of choice and go to the bottom. There, you'll find a few settings:
|
To configure settings, open `~/.welcome/config.cfg` in your text editor of choice. There, you'll find a few settings:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
#==================SETUP=================#
|
#==================SETUP=================#
|
||||||
|
@ -60,25 +58,39 @@ To configure settings, open `welcome.sh` in your text editor of choice and go to
|
||||||
|
|
||||||
greetings=("Welcome" "Greetings" "Hello" "Hi") # Add your own greetings!
|
greetings=("Welcome" "Greetings" "Hello" "Hi") # Add your own greetings!
|
||||||
randgreeting="off" #< Turn the random greetings on (eg. "Hello <user>, Hi <user>")
|
randgreeting="off" #< Turn the random greetings on (eg. "Hello <user>, Hi <user>")
|
||||||
twelvehour="on" #< Switch between 12 and 24 hour time (eg. 8:00pm vs 20:00)
|
twelvehour="on" #< Switch between 12 and 24 hour time (eg. 8:00 PM vs 20:00)
|
||||||
rechargenotif="off" #< Notify that you should recharge if below 15%
|
rechargenotif="off" #< Notify that you should recharge if below 15%
|
||||||
flatpakupd="off" #< Check for flatpak updates, this slows startup down A LOT
|
flatpakupd="off" #< Check for flatpak updates, this slows startup down A LOT
|
||||||
goodgreeting="on" #< Display greetings like "Good afternoon," else "It's afternoon"
|
goodgreeting="on" #< Display greetings like "Good afternoon," else "It's afternoon"
|
||||||
|
displaydate="off" #< Unused so far
|
||||||
|
|
||||||
welcome
|
#=========COLORS=======#
|
||||||
greeting
|
NCOL='\e[0m'
|
||||||
clock
|
BOLD='\e[1m'
|
||||||
battery
|
ITAL='\e[3m'
|
||||||
updates
|
UNDR='\e[4m'
|
||||||
echo # Properly line break at the end
|
BLNK='\e[5m'
|
||||||
|
|
||||||
|
# Battery level colors
|
||||||
|
CRIT='\e[31m'
|
||||||
|
LOW='\e[33m'
|
||||||
|
NORM='\e[32m'
|
||||||
|
FULL='\e[3;4;92m'
|
||||||
|
|
||||||
|
TIME='\e[38;2;224;146;252;1m' # Clock color
|
||||||
|
DATE='\e[38;2;50;168;82;1m' # Future "Date" item color
|
||||||
|
USRC=$(randcolor) # Username color
|
||||||
|
|
||||||
|
# Greeting colors
|
||||||
|
NIGH='\e[38;2;200;107;209m'
|
||||||
|
MORN='\e[38;2;255;164;74m'
|
||||||
|
AFTN='\e[38;2;250;245;110m'
|
||||||
|
EVEN='\e[38;2;171;54;3m'
|
||||||
|
|
||||||
|
cfgversion=1
|
||||||
```
|
```
|
||||||
|
|
||||||
Here, you can re-arrange the modules, and turn off and on flatpak and recharge notifications. I recommend leaving flatpak off as it makes startup incredibly slow.
|
|
||||||
|
|
||||||
I'm planning on making this config section a separate file later to make changing settings easier and updating easier.
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
### TODO:
|
### TODO:
|
||||||
- [x] Add easier way to install and update
|
|
||||||
- [ ] Fix issues across other distros
|
- [ ] Fix issues across other distros
|
||||||
- [ ] Add new features?
|
- [ ] Add new features? (Please suggest!)
|
||||||
|
|
Loading…
Reference in a new issue