mirror of
https://github.com/G2-Games/welcome.sh.git
synced 2025-04-19 13:32:53 -05:00
Update README.md
This commit is contained in:
parent
13a8de8b76
commit
a486bd04ef
1 changed files with 19 additions and 2 deletions
21
README.md
21
README.md
|
@ -5,9 +5,16 @@ This is a nice little script for your `.bashrc` that greets you on every launch,
|
|||
|
||||
My goal with this script is to keep it simple, just a single line that gives useful information when you start the terminal.
|
||||
|
||||
#### 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:
|
||||
#### Via Curl
|
||||
Run `bash -c "$(curl -s https://raw.githubusercontent.com/G2-Games/welcome-sh/main/install.sh)"` to install it.
|
||||
Run `bash -c "$(curl -s https://raw.githubusercontent.com/G2-Games/welcome-sh/main/install.sh)"` to install it. It installs to `~/.welcome/welcome.sh`
|
||||
|
||||
Run it again to uninstall.
|
||||
|
||||
|
@ -18,8 +25,18 @@ To use it, download `welcome.sh` and place it in your home directory. Then add `
|
|||
WIP
|
||||
|
||||
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>
|
||||
|
||||
### 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:
|
||||

|
||||
|
||||
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>
|
||||
|
||||
### TODO:
|
||||
- [x] Add easier way to install and update
|
||||
- [ ] Fix issues across other distros
|
||||
- [ ] Add features?
|
||||
- [ ] Add new features?
|
||||
|
|
Loading…
Reference in a new issue