dotfiles/README.md

5.9 KiB

Dotfiles

These are my personal dotfiles. They're split into home/ and root/ folders where the home folder holds all files that should be put directly into your $HOME directory, while all of the files in the root folder can be put directly into /

You are highly adviced to first go through these dotfiles yourself and adjust them to your liking.

Sample images

  • Custom prompt (defined here.
    • Colorscheme showcase: image
    • Command timing showcase: image
  • Neovim configuration (defined here) image
  • Automatic unknown command package handler image
  • lf file manager previews with ueberzug image

Features

  • Full fledged ZSH configuration without the need to rely on oh-my-zsh
    • oh-my-zsh configuration is also supported, but it is off by default, adjust .zshrc to enable it
    • Even though enabling it is an option, it is not a necessary thing to do, oh-my-zsh has a lot of code that is mostly irrelevant and unused, these dotfiles give you the ability to completely avoid it, if you desire to do so
  • Custom prompt, both for oh-my-zsh configuration or for standalone usage
  • Custom VIM configuration
    • When you open nvim for the first time, it will automatically try to install addons using VimPlug
    • It is complatible with TTY usage, in which case the color support is downgraded and use of special fonts is disabled.
    • There isn't a single huge configuration file, but rather multiple config files that are being sourced by the main init.vim, this is done to avoid clutter with comments in the main file and it also provides a very easy way to disable parts of configuration, by simply not sourcing that file.
    • NOTE: This configuration is mostly designed for neovim, not regular vim, however it should work with some adjustments
  • Many handy aliases and functions (likely too many, you should adjust that to your needs)
  • Many pre-defined environmental variables, these include
    • XDG paths configuration to avoid too much cluttering in home directory
    • Colorful man pages using LESS_TERMCAP, or if bat is installed, using it as MANPAGER
  • Automatic handlers which override default command not found behavior to show the package to which given command belongs (requires pkgfile on Arch Linux)
  • List of useful packages that I often install on most of my systems. (These are the package names for arch linux, but you should be able to find these for any distro, perhaps with a bit different name) located in packages.yaml
  • Opensnitch firewall rules, which block most unauthorized traffic and only allow needed things. This also blocks spotify ads.
  • Automatic logout for TTY sessions or for root logins after 10 minutes of inactivity
  • NetworkManager configuration which assigns new mac for each network
  • lf file manager configuration with support for ueberzug image previews within the terminal
  • Tons of handy scripts for automating common tasks
    • incremental-backup: Easy way to utilize rsync for all backups, without the need for external software
    • auto-chroot: Quick way to chroot into any other linux system, without typing the very repetetive mount and umount commands
    • tamper-check: Script that uses checksums to verify that given files weren't adjusted in any way.
    • brightness: Script to quickly change screen brightness, you may need to adjust the BRIGHTNESS_FILE, this can be different from machine to machine
    • setbg: Quick way to set desktop background to specific image, or random image, or previously used image
    • Many smaller dmenu scripts to make life easier

Requirements

curl and tar, or git to clone the repository itself.

Installation

Clone this repository anywhere you like $ git clone https://github.com/ItsDrike/dotfiles

If you don't want to install git (running straight from newly installed os), you can use curl:
$ curl -LJO https://github.com/ItsDrike/dotfiles/tarball/master
And extract from .tar.gz archive: $ tar xvf [archive name]

Attribution

The open-source community has an incredible amount of resources that people have offered to others free of charge and we all depend on many of these sources. This project is no different and there were many open-source projects that were utilized in some parts of this project. For that reason, I'd like tho thank all of these projects and their contributors for keeping their content open and available to everyone. This is the list of projects that helped me build this repository to the stage it's in now. Many of the aliases, config files and other resources aren't my original creations, but rather just small improvements and adjustments to get everything set in the way I like. Below is the list of all projects which helped the existence of this repository: