Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/timvisee/dotfiles
:octocat: Tim does dotfiles
https://github.com/timvisee/dotfiles
awesomewm dotfiles dots ergodox fish linux tmux vim
Last synced: 3 months ago
JSON representation
:octocat: Tim does dotfiles
- Host: GitHub
- URL: https://github.com/timvisee/dotfiles
- Owner: timvisee
- License: gpl-3.0
- Created: 2016-09-05T12:45:28.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-11T10:22:03.000Z (6 months ago)
- Last Synced: 2024-06-18T00:38:39.396Z (5 months ago)
- Topics: awesomewm, dotfiles, dots, ergodox, fish, linux, tmux, vim
- Language: Vim Script
- Homepage: https://timvisee.com/
- Size: 10.3 MB
- Stars: 21
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - timvisee/dotfiles - :octocat: Tim does dotfiles (Vim Script)
README
# Tim does dotfiles
dotfiles are used to personalize your system and applications. These are mine.
## Requirements
* Linux or Mac OS X
* `git`
* `bash`
* When using Vim, [vim-plug][vim-plug] is installed.
## Recommendations
* `alacritty`: awesome terminal emulator
* `bspwm`: tiling window manager, additional dependencies
* `sxhkd`: shortcut daemon
* `polybar`: desktop bar
* `picom`: compositor
* `dunst`: notification daemon
* `pasystray`: PulseAudio tray icon
* `xss-lock`: X screensaver lockscreen
* `slock`: X lockscreen
* `maim`: screenshotter
* `rofi`: interactive selector
* `playerctl`: MPRIS media controls
* `awesomeWM`: tiling window manager, additional dependencies
* `awesome`: window manager itself
* `awesome-extra`: additional libraries used in my configuration
* `i3lock-color-git`: [[link]](https://github.com/chrjguill/i3lock-color) fancy and customizable lock screen
* `xautolock`: lock screen when inactive
* `libnotify-bin`: notification handling
* `rust` nightly: for proper language completion in Vim, through `rustup`
* `xcape` (Linux): to bind Caps Lock to Esc.
* `keychain`: for SSH key management
* `fish`: as better shell
* `starship`: as better shell prompt
* `thefuck`: for handy incorrect command fixes
* `highlight`: for syntax highlighting in ranger
## Installation
An installation script is included to easily install the dotfiles on your system.
On Linux or Mac OS X, use:
```bash
# Clone the repository
git clone https://github.com/timvisee/dotfiles.git ~/dotfiles
cd ~/dotfiles
# Install
sudo chmod a+x ./install
./install
```
Vim plugins should be installed automatically, the `:PlugInstall` command may be
used to force.
### Alacritty
This configuration recommends [`alacritty`][alacritty] as default terminal.
First, install it as stated on it's GitHub page.
Then configure it as default terminal using:
```bash
# Add alacritty to the terminal list
sudo update-alternatives --install /usr/bin/x-terminal-emulator x-terminal-emulator $(which alacritty) 0
# Select the default terminal
sudo update-alternatives --config x-terminal-emulator
```
## ErgoDox
This repository includes my ErgoDox keyboard layout configuration,
located in the [ergodox](./ergodox) directory.
## Hosts blacklist
This repository includes my personal hosts banlist.
The up-to-date raw file can be accessed via
[`https://gitlab.com/timvisee/dotfiles/raw/master/hosts/blacklist.txt`](https://gitlab.com/timvisee/dotfiles/raw/master/hosts/blacklist.txt).
## License
This project is released under the GNU GPL-3.0 license. Check out the [LICENSE](LICENSE) file for more information.
[alacritty]: https://github.com/jwilm/alacritty
[vim-plug]: https://github.com/junegunn/vim-plug