Commit d45a7ecd authored by Benedikt Vollmerhaus's avatar Benedikt Vollmerhaus

Add README.md

parent 114ef7c7
# Benedikt's dotfiles
This repository includes most of my personal dotfiles (configuration and ricing)
for the applications listed below. Enjoy!
## Requirements
Unused dotfiles are simply that - unused, so not all of the applications
below have to be installed or actively used for these dotfiles to function.
Some of the dotfiles however may require specific packages to be available
on the target system, so make sure you have the following installed before
using these dotfiles. The listed package names correspond to the Arch repos,
but should be available in other distribution's repos as well.
| Name | Repository | Package(s) | Description |
| ---- | ---------- | ---------- | ----------- |
| Nerd Fonts | [GitHub](https://github.com/ryanoasis/nerd-fonts) | nerd-fonts-complete ([AUR](https://aur.archlinux.org/packages/nerd-fonts-complete/)) | A collection of fonts patched with >3600 glyphs (icons).
## Installation
1. Clone this repository and run the `install` script to automatically symlink
the dotfiles in your ~/.config directory.
2. This repository also includes my [desktop scripts](https://gitlab.com/BVollmerhaus/scripts)
as a submodule. These require a few Python and system packages, the first of
which may be installed automatically in step 1 if you choose so. You'll still
have to install any required system packages yourself however, in case they
aren't already included with your distro. They most likely will with common
distros such as Ubuntu, but here's how to install them on Arch:
```
pacman -S wmctrl libnotify
```
If you don't want to install these dependencies or use my scripts, you should
probably remove them from the "Autostart" section in the i3 config.
## Applications
### User Interface / DE
| Name | Repository | Package(s) | Description |
| ---- | ---------- | ---------- | ----------- |
| i3-gaps | [GitHub](https://github.com/Airblader/i3) | i3-gaps ([Arch](https://www.archlinux.org/packages/community/x86_64/i3-gaps/)) | The well-known i3 tiling window manager, enhanced with support for gaps.
| Polybar | [GitHub](https://github.com/jaagr/polybar) | polybar ([AUR](https://aur.archlinux.org/packages/polybar/)) | A nicer looking and more customizable alternative to i3bar, great for ricing.
| twmn | [GitHub](https://github.com/sboli/twmn) | twmn-git ([AUR](https://aur.archlinux.org/packages/twmn-git/)) | Small & simple notification daemon for tiling WMs using an animated slide.
### Terminals
| Name | Repository | Package(s) | Description |
| ---- | ---------- | ---------- | ----------- |
| URxvt | [CVS](http://cvs.schmorp.de/rxvt-unicode/) | rxvt-unicode ([Arch](https://www.archlinux.org/packages/community/x86_64/rxvt-unicode/)) | An [rxvt](http://rxvt.sourceforge.net/) fork with Unicode support, transparency & other modern stuff.
| Alacritty | [GitHub](https://github.com/jwilm/alacritty) | alacritty-git ([AUR](https://aur.archlinux.org/packages/alacritty-git/)) | When URxvt is too slow for the job, we use a GPU-accelerated terminal.
### Productivity
| Name | Repository | Package(s) | Description |
| ---- | ---------- | ---------- | ----------- |
| ranger | [GitHub](https://github.com/ranger/ranger) | ranger ([Arch](https://www.archlinux.org/packages/community/any/ranger/)) | An easily extendable file manager for the terminal with Vim-style key bindings.
| Rofi | [GitHub](https://github.com/DaveDavenport/rofi) | rofi ([Arch](https://www.archlinux.org/packages/community/x86_64/rofi/)) | Window switcher, application launcher and dmenu replacement, all in one tool.
| fzf | [GitHub](https://github.com/junegunn/fzf) | fzf ([Arch](https://www.archlinux.org/packages/community/x86_64/fzf/)) | A fuzzy finder for the terminal; very useful for accessing the command history.
### Ricing (Theming)
| Name | Repository | Package(s) | Description |
| ---- | ---------- | ---------- | ----------- |
| Pywal | [GitHub](https://github.com/dylanaraps/pywal) | python-pywal ([Arch](https://www.archlinux.org/packages/community/any/python-pywal/)), [PyPI](https://pypi.org/project/pywal/) | Generates color schemes for i3, the terminal, etc. from wallpapers.
### Editors
| Name | Repository | Package(s) | Description |
| ---- | ---------- | ---------- | ----------- |
| Vim | [GitHub](https://github.com/vim/vim) | vim ([Arch](https://www.archlinux.org/packages/extra/x86_64/vim/)) | One of the most widely known and fully-featured modal text editors.
| Kakoune | [GitHub](https://github.com/mawww/kakoune) | kakoune ([Arch](https://www.archlinux.org/packages/community/x86_64/)) | A Vim-replacement with a focus on [interactivity](http://kakoune.org/why-kakoune/why-kakoune.html) and visual feedback.
## Install-it-all (Arch and derivatives)
You can use the following beefy command to install all of the
above Arch packages:
```
pacman -S i3-gaps rxvt-unicode ranger rofi fzf python-pywal vim kakoune
```
And to install the AUR packages with your AUR helper of choice
([`yay`](https://aur.archlinux.org/packages/yay/) in this case):
```
yay -S polybar twmn-git alacritty-git
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment