G2/welcome.sh
1
1
Fork 0
mirror of https://github.com/G2-Games/welcome.sh.git synced 2025-04-19 05:22:53 -05:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'main' of https://github.com/G2-Games/welcome-sh

Browse source
This commit is contained in:
G2-Games 2022-09-03 22:48:30 -05:00
commit 99cd245e9c
1 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,15 +1,14 @@
# welcome.sh
![image](https://user-images.githubusercontent.com/72430668/188241809-fd94292e-23a4-4bba-bb76-82b863bbdddb.png)
### A nice welcome script for Bash
This is a nice little script for your `.bashrc` that greets you on every launch, with some helpful (and customizable!) information.
### A nice welcome script for Bash and Zsh
This is a nice little script for your `.bashrc` or `.zshrc` that greets you on every launch, with some helpful (and customizable!) information.
My goal with this script is to keep it simple, just a single line that gives useful information when you start the terminal.
My goal with this script is to keep it simple, just a single line that gives useful information when you start a terminal session.
#### Features:
- Relatively fast
- <span title="Please let me know of other things to support!">Works across many distros (update checking support)</span>
- Clean and simple
- Written entirely in Bash
<hr>
### Installing:
@ -17,17 +16,23 @@ My goal with this script is to keep it simple, just a single line that gives use
```
bash -c "$(curl -s https://raw.githubusercontent.com/G2-Games/welcome.sh/main/install.sh)"
```
```
zsh -c "$(curl -s https://raw.githubusercontent.com/G2-Games/welcome.sh/main/install.sh)"
```
#### Or wget
```
bash -c "$(wget -q https://raw.githubusercontent.com/G2-Games/welcome.sh/main/install.sh -O -)"
```
```
zsh -c "$(wget -q https://raw.githubusercontent.com/G2-Games/welcome.sh/main/install.sh -O -)"
```
It installs to `~/.welcome/welcome.sh`, and adds a line to the bottom of `~/.bashrc`
It installs to `~/.welcome/welcome.sh`, and adds a line to the bottom of `~/.bashrc` or `~/.zshrc`
Run again to uninstall.
Run again to uninstall. Uninstalling will remove it from both Bash and Zsh.
#### 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 `welcome.sh` and place it in your home directory. Then add `/home/$USER/welcome.sh` to your `.bashrc`.
### Updating:
WIP
@ -38,8 +43,22 @@ Currently you can update by uninstalling and reinstalling, but this wipes all se
### 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:
![github2](https://user-images.githubusercontent.com/72430668/188288031-78727633-79da-42c4-8f1e-1fdafb9fe1a2.png)
```bash
#=========SETUP========#
# Select which parts you want active by commenting them out
# For example, on a desktop, disabling the battery message is a good idea
# You can also re order them to change how they display!
flatpakupd="off" # Check for flatpak updates, this slows startup down A LOT
rechargenotif="off" # Notify that you should recharge if below 15%
welcome
greeting
clock
battery
updates #< This makes startup slower
echo # Properly line break at the end
```
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.