~stick/dotfiles

81670688d4de4f837f133252914835f6ebb5694e — Stick 3 months ago 7bf8d60
update README for waybar; shfmt
1 files changed, 23 insertions(+), 21 deletions(-)

M README.md
M README.md => README.md +23 -21
@@ 17,21 17,23 @@

Includes configuration for:

* `aconfmgr`
* `alacritty`
* `aurman`
* `bash`
* `gdb`
* `git`
* `sway` (with `swaylock` )
* `tmux`
* `vim` (including plugins as submodules)
- `aconfmgr`
- `alacritty`
- `aurman`
- `bash`
- `gdb`
- `git`
- `sway` (with `swaylock` )
- `tmux`
- `vim` (including plugins as submodules)
- `waybar`

Also includes a set of scripts and small executables used throughout the configuration (`./bin/`).

### Acknowledgements:

This repository's [logo](logo.png) has been shamelessly ~~stolen~~ borrowed from [Ícaro Medeiros](https://dotfiles.zeef.com/icaro.medeiros). Many other sources are linked throughout the configuration files.
This repository's [logo](logo.png) has been shamelessly ~~stolen~~ borrowed from [Ícaro Medeiros](https://dotfiles.zeef.com/icaro.medeiros).
Many other sources are linked throughout the configuration files.

## Install



@@ 39,7 41,7 @@ My dotfiles are kept in a bare repo on `$HOME`, as [suggested](https://news.ycom

1. Clone as a bare repository to `$HOME/.dotfiles`.
1. Create the `dots` alias to interact with the repository.
1. Check out the `workstation`  branch.
1. Check out the `workstation` branch.

```bash
$ git clone --bare https://git.sr.ht/~stick/dotfiles $HOME/.dotfiles


@@ 57,24 59,24 @@ You should (back up and) remove the offending files and simply re-run the checko

The included sway configuration requires the following packages as dependencies (listings are for Arch Linux; YMMV):

* `alacritty` (terminal emulator; also used for launcher)
* `i3status-rust` (status command for swaybar) ([AUR](https://aur.archlinux.org/packages/i3status-rust/))
* `otf-font-awesome` (used in info bar)
* `polkit-gnome` (PolicyKit integration in gdm and sway)
* `python-i3ipc` (Python library to control sway)
* `sway` (window manager)
- `adobe-source-code-pro-fonts` (default font)
- `alacritty` (terminal emulator; also used for launcher)
- `otf-font-awesome` (used in info bar)
- `polkit-gnome` (PolicyKit integration in `gdm` and `sway`)
- `python-i3ipc` (Python library to control `sway`)
- `sway` (window manager)
- `waybar` (status bar and system tray)

#### Optional

* `adobe-source-code-pro-fonts` (default font)
* `libpulse` (volume control)
* `playerctl` (music player controls)
- `libpulse` (volume control)
- `playerctl` (music player controls)

## Usage

Use the `dots` alias (made permanent in `.bashrc`) to interact with the repository.

**NOTE:** The `.gitignore` has a `*` rule which matches *everything*, so you must use `-f` or `--force` when adding files or submodules.
**NOTE:** The `.gitignore` has a `*` rule which matches _everything_, so you must use `-f` or `--force` when adding files or submodules.

I typically use `gdm` to handle workstation login; it is included in the `aconfmgr` configuration.