update readme

This commit is contained in:
Amolith 2020-10-06 17:47:41 -04:00
parent d77e55fa04
commit 90cdf916a5
Signed by: Amolith
GPG Key ID: 5548AD9930655715
1 changed files with 12 additions and 14 deletions

View File

@ -15,27 +15,25 @@ This is a repository of my [dotfiles](https://wiki.archlinux.org/index.php/Dotfi
## Setup (dependencies)
All of the colours are based on [base16-unikitty-dark](https://github.com/joshwlewis/base16-unikitty).
* **WM:** [sway](https://github.com/swaywm/sway/)
* **Status bar:** [Waybar](https://github.com/Alexays/Waybar)
* **Application launcher:** [wofi](https://hg.sr.ht/~scoopta/wofi)
* **Notification daemon:** [mako](https://github.com/emersion/mako/)
* **WM:** [i3wm](https://i3wm.org/)
* **Status bar:** [polybar](https://github.com/polybar/polybar/)
* **Application launcher:** [rofi](https://github.com/DaveDavenport/rofi)
* **Notification daemon:** [dunst](https://wiki.archlinux.org/index.php/Dunst)
* **Terminal:** [kitty](https://github.com/kovidgoyal/kitty)
* **Text editor:** [neovim](https://github.com/neovim/neovim)
* **Music player:** [mpd](https://github.com/MusicPlayerDaemon/MPD)/[ncmpcpp](https://github.com/ncmpcpp/ncmpcpp)
* **Email client:** [aerc](https://git.sr.ht/~sircmpwn/aerc)
* **IRC client:** [weechat](https://weechat.org/)
* **Scheduling:** [calcurse](https://github.com/lfos/calcurse)
* **Multiplexer:** [tmux](https://github.com/tmux/tmux)
* **Todo list:** [taskell](https://github.com/smallhadroncollider/taskell)
## dotgit
While incredibly useful, I find dotgit's documentation rather lacking so here are some random snippets that may help with managing your own dotfiles with it.
I'm in the process of fully migrating to Emacs for text editing, organisation,
and long-form writing. I'm also exploring possibilities for using it as a music
player, feed reader, and email client but we'll see.
* When starting to use dotgit, initialise the repo, add what you want saved to the `filelist`, then run `dotgit update` because . . .
* dotgit will handle moving around *all* of your files. You can create your configs in `~/.config/path/to/conf` or wherever else then include that path in your `filelist`. When you run `dotgit update`, the config will then be moved to your dotfiles repo and a symlink put in your home folder.
* `dotgit generate` is not really necessary, it might just save you some time if you're not used to working with git.
* Encryption is odd and I haven't tested it with multiple devices yet. I'm not sure if the `passwd` file is safe to include in a public repo or if it's necessary to decrypt sensitive configs.
* If you want to drop my desktop configs onto your system and start using them as they are, you'll need to edit the `filelist` and replace `cetus` with whatever your `$ hostname` is.
## Deploying
* Ensure `python3` is installed
* Clone with `git clone --recurse-submodules https://git.nixnet.xyz/Amolith/dotfiles`
* Edit the filelist to your liking (replace hostnames)
* Run `./bin/setup`
## Screenshots
### Clean desktop