Add short install snippet to README

This commit is contained in:
Salt 2019-06-22 02:01:24 -05:00
parent 5809078169
commit e25c8296ac

View File

@ -8,6 +8,17 @@
Execute `firestarter` in your `.xinitrc`, either by replacing the file or by `exec`ing it after performing your own basic setup. You do not need the rest of the files in the repository, but a `git clone` and a regular `git pull` *is* an effective way of keeping the script up-to-date. Execute `firestarter` in your `.xinitrc`, either by replacing the file or by `exec`ing it after performing your own basic setup. You do not need the rest of the files in the repository, but a `git clone` and a regular `git pull` *is* an effective way of keeping the script up-to-date.
If you just want something to copy and paste into a terminal, try this:
```bash
cd
git clone https://gitlab.com/rehashedsalt/firestarter .firestarter
[ -f "~/.xinitrc" ] && mv "~/.xinitrc" "~/.xinitrc.bak"
ln -s .firestarter/firestarter .xinitrc
```
Lastly, make sure you're not executing a bunch of stuff from your WM's config. Firestarter will handle the startup of bars, Pulse, etc. by itself.
## Configuration ## Configuration
On first run and when invoked with `firestarter -g`, Firestarter will generate a series of configuration files in `~/.config/firestarter`. These files consist of several lines that look somewhat like the following: On first run and when invoked with `firestarter -g`, Firestarter will generate a series of configuration files in `~/.config/firestarter`. These files consist of several lines that look somewhat like the following: