Update README some more

This commit is contained in:
Salt 2020-06-07 08:13:14 -05:00
parent cf4da59082
commit 16f58d2604

View File

@ -2,22 +2,15 @@
## Overview
**Firestarter** is a desktop environment startup script. Its job is to abstract out the startup and configuration of basic X session components. By default, it will attempt to piece together a fully functional desktop environment based on currently available programs and configuration files found in `~/.config/firestarter`.
**Firestarter** is a desktop environment startup script/service manager. Its job is to abstract out the startup and configuration of basic X session components. It will attempt to piece together a fully functional desktop environment based on currently available programs and configuration files found in `~/.config/firestarter`.
## Installation
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`, ideally by `exec`ing it after performing your own basic setup.
If you just want something to copy and paste into a terminal, try this:
Additionally, you will need to configure Firestarter. See the section below on how to do that.
```bash
cd
git clone https://gitlab.com/rehashedsalt/firestarter .firestarter
[ -e "~/.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.
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. Double-executing will just cause more problems.
## Configuration