diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 42 insertions, 6 deletions
@@ -1,14 +1,50 @@ # dotfiles -Dotfiles for my machines. While I don't recommend using them (since everybody has highly specific needs), you're welcome to look around. +Dotfiles for my machines. These configurations have been tested on a regular PC, M1 Mac running Asahi Linux, and even a Steam Deck. -## Usage +## Programs -For fast installation, I wrote a small script to copy the dotfiles to their destinations. +This repository contains configurations for the following programs, intended to be run on either Arch Linux or Asahi Linux (/Arch Linux ARM). Some (but not all) configurations will also work without any further editing on macOS. -The script also installs some utilities that I use. This is all defined in `info.yml`. +### Text-based -To use this script, simply run: +* [git](https://git-scm.com/) +* [neovim](https://neovim.io/) (*editor*) + * [onedark.vim](https://github.com/joshdick/onedark.vim) (*theme*) + * [vim-airline](https://github.com/vim-airline/vim-airline) (*status bar*) +* [tmux](https://github.com/tmux/tmux) (*multiplexer*) +* [zsh](https://www.zsh.org/) (*shell*) + * [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) + +### Graphical + +* [alacritty](https://alacritty.org/) (*terminal emulator*) +* [mako](https://github.com/emersion/mako) (*notifications*) +* [sway](https://swaywm.org/) (*WM*) +* [swaylock](https://github.com/swaywm/swaylock) +* [swayidle](https://github.com/swaywm/swayidle) +* [waybar](https://github.com/Alexays/Waybar) (*status bar*) +* [wofi](https://sr.ht/~scoopta/wofi/) (*launcher*) +* ~~[iTerm2](https://iterm2.com/)~~ (*terminal emulator, not currently in use*) +* ~~[rofi](https://github.com/davatorium/rofi)~~ (*launcher, not currently in use*) + +## Install + +This repository is designed to be installed with my own [dotfiles-installer](https://github.com/LMBishop/dotfiles-installer) program. Unless you happen to be me, I wouldn't suggest using this. + +Arch / Asahi: ``` -$ ./deploy.py +$ dotfiles-installer -f install-arch.yml ``` + +macOS - requires the Xcode command line tools: + +``` +$ dotfiles-installer -f install-macos.yml +``` + +## Screenshots + + + +
\ No newline at end of file |