ref: 81670688d4de4f837f133252914835f6ebb5694e dotfiles/README.md -rw-r--r-- 3.4 KiB View raw
81670688Stick update README for waybar; shfmt 4 months ago


license standard-readme compliant

stick's configuration files

Table of Contents


Includes configuration for:

  • 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/).


This repository's logo has been shamelessly stolen borrowed from Ícaro Medeiros. Many other sources are linked throughout the configuration files.


My dotfiles are kept in a bare repo on $HOME, as suggested by StreakyCobra and written up by durdn (hat tip @sir@cmpwn.com).

  1. Clone as a bare repository to $HOME/.dotfiles.
  2. Create the dots alias to interact with the repository.
  3. Check out the workstation branch.
$ git clone --bare https://git.sr.ht/~stick/dotfiles $HOME/.dotfiles
$ alias dots='git --git-dir=$HOME/.dotfiles/ --work-tree=$HOME'
$ dots checkout workstation
$ dots submodule update --init --recursive --remote

NOTE: Performing the checkout will likely fail due to files already in place (.bashrc, .tmux.conf, .vim, etc). You should (back up and) remove the offending files and simply re-run the checkout.



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

  • 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)
  • libpulse (volume control)
  • playerctl (music player controls)


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.

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


Contributors to this project adhere to the Code of Conduct.

I welcome issues, but I prefer pull requests! We follow the trunk-based development model (where your fork is a "feature branch"). Contributions should use git with discipline.


Copyright © 2017-2019 stick. Where not otherwise specified, this repository is licensed under the Mozilla Public License 2.0.