mirror of
https://github.com/ItsDrike/dotfiles.git
synced 2024-12-26 13:14:35 +00:00
Improve readme formatting
This commit is contained in:
parent
efea925583
commit
d4dbe64515
58
README.md
58
README.md
|
@ -1,13 +1,15 @@
|
||||||
# Dotfiles
|
# 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 `/`
|
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.
|
You are highly advised to first go through these dotfiles yourself and adjust them to your liking.
|
||||||
|
|
||||||
|
|
||||||
## Sample images
|
## Sample images
|
||||||
|
|
||||||
- Custom prompt (defined [here](home/.config/shell/theme).
|
- Custom prompt (defined [here](home/.config/shell/theme)).
|
||||||
- Colorscheme showcase: ![image](https://user-images.githubusercontent.com/20902250/117699472-69ab5d80-b1b4-11eb-85a8-2b039bc1599a.png)
|
- Colorscheme showcase: ![image](https://user-images.githubusercontent.com/20902250/117699472-69ab5d80-b1b4-11eb-85a8-2b039bc1599a.png)
|
||||||
- Command timing showcase: ![image](https://user-images.githubusercontent.com/20902250/129356038-f1373183-ee50-4cc9-a602-a1215b5d1e5f.png)
|
- Command timing showcase: ![image](https://user-images.githubusercontent.com/20902250/129356038-f1373183-ee50-4cc9-a602-a1215b5d1e5f.png)
|
||||||
- Neovim configuration (defined [`here`](home/.config/nvim/)) ![image](https://user-images.githubusercontent.com/20902250/129356722-9eb1e813-62c4-4ad1-ad49-114f69700f80.png)
|
- Neovim configuration (defined [`here`](home/.config/nvim/)) ![image](https://user-images.githubusercontent.com/20902250/129356722-9eb1e813-62c4-4ad1-ad49-114f69700f80.png)
|
||||||
|
@ -17,43 +19,55 @@ You are highly adviced to first go through these dotfiles yourself and adjust th
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Full fledged ZSH configuration without the need to rely on oh-my-zsh
|
- 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`](home/.config/zsh/.zshrc) to enable it
|
- oh-my-zsh configuration is also supported, but it is off by default, adjust [`.zshrc`](home/.config/zsh/.zshrc) to
|
||||||
- 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
|
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](home/.config/shell/theme), both for oh-my-zsh configuration or for standalone usage
|
- Custom [prompt](home/.config/shell/theme), both for oh-my-zsh configuration or for standalone usage
|
||||||
- Custom [VIM configuration](home/.config/nvim)
|
- Custom [VIM configuration](home/.config/nvim)
|
||||||
- When you open nvim for the first time, it will automatically try to install addons using VimPlug
|
- 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.
|
- It is compatible with TTY usage, in which case the color support is downgraded and use of special fonts is
|
||||||
- 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.
|
disabled.
|
||||||
- NOTE: This configuration is mostly designed for neovim, not regular vim, however it should work with some adjustments
|
- There isn't a single huge configuration file, but rather multiple config files that are being sourced by the main
|
||||||
- Many handy [aliases](home/.config/shell/aliases) and [functions](home/.config/shell/functions) (likely too many, you should adjust that to your needs)
|
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](home/.config/shell/aliases) and [functions](home/.config/shell/functions) (likely too many, you
|
||||||
|
should adjust that to your needs)
|
||||||
- [Many pre-defined environmental variables](home/.config/shell/environ), these include
|
- [Many pre-defined environmental variables](home/.config/shell/environ), these include
|
||||||
- XDG paths configuration to avoid too much cluttering in home directory
|
- 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
|
- Colorful man pages using LESS_TERMCAP, or if `bat` is installed, using it as MANPAGER
|
||||||
- [Automatic handlers](home/.config/shell/handlers) which override default command not found behavior to show the package to which given command belongs (requires pkgfile on Arch Linux)
|
- [Automatic handlers](home/.config/shell/handlers) which override default command not found behavior to show the
|
||||||
- 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`](packages.yaml)
|
package to which given command belongs (requires pkgfile on Arch Linux)
|
||||||
- [Opensnitch firewall rules](root/etc/opensnitchd/rules), which block most unauthorized traffic and only allow needed things. This also blocks spotify ads.
|
- 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`](packages.yaml)
|
||||||
|
- [Opensnitch firewall rules](root/etc/opensnitchd/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
|
- Automatic logout for TTY sessions or for root logins after 10 minutes of inactivity
|
||||||
- NetworkManager configuration which assigns new mac for each network
|
- NetworkManager configuration which assigns new mac for each network
|
||||||
- `lf` file manager configuration with support for ueberzug image previews within the terminal
|
- `lf` file manager configuration with support for ueberzug image previews within the terminal
|
||||||
- Tons of handy scripts for automating common tasks
|
- Tons of handy scripts for automating common tasks
|
||||||
- [`incremental-backup`](root/usr/local/bin/incremental-backup): Easy way to utilize rsync for all backups, without the need for external software
|
- [`incremental-backup`](root/usr/local/bin/incremental-backup): Easy way to utilize rsync for all backups, without
|
||||||
- [`auto-chroot`](root/usr/local/bin/auto-chroot): Quick way to chroot into any other linux system, without typing the very repetetive mount and umount commands
|
the need for external software
|
||||||
- [`tamper-check`](root/usr/local/bin/tamper-check): Script that uses checksums to verify that given files weren't adjusted in any way.
|
- [`auto-chroot`](root/usr/local/bin/auto-chroot): Quick way to chroot into any other linux system, without typing
|
||||||
- [`brightness`](home/.local/bin/scripts/brightness): Script to quickly change screen brightness, you may need to adjust the BRIGHTNESS_FILE, this can be different from machine to machine
|
the very repetitive mount and umount commands
|
||||||
- [`setbg`](home/.local/bin/scripts/setbg): Quick way to set desktop background to specific image, or random image, or previously used image
|
- [`tamper-check`](root/usr/local/bin/tamper-check): Script that uses checksums to verify that given files weren't
|
||||||
|
adjusted in any way.
|
||||||
|
- [`brightness`](home/.local/bin/scripts/brightness): Script to quickly change screen brightness, you may need to
|
||||||
|
adjust the BRIGHTNESS_FILE, this can be different from machine to machine
|
||||||
|
- [`setbg`](home/.local/bin/scripts/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
|
- Many smaller dmenu scripts to make life easier
|
||||||
|
|
||||||
|
|
||||||
## Requirements
|
|
||||||
|
|
||||||
`curl` and `tar`, or `git` to clone the repository itself.
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Clone this repository anywhere you like
|
Clone this repository anywhere you like
|
||||||
`$ git clone https://github.com/ItsDrike/dotfiles`
|
`$ 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`: <br>
|
If you don't want to install git (running straight from newly installed OS), you can use `curl`: <br>
|
||||||
`$ curl -LJO https://github.com/ItsDrike/dotfiles/tarball/master` <br>
|
`$ curl -LJO https://github.com/ItsDrike/dotfiles/tarball/master` <br>
|
||||||
And extract from `.tar.gz` archive:
|
And extract from `.tar.gz` archive:
|
||||||
`$ tar xvf [archive name]`
|
`$ tar xvf [archive name]`
|
||||||
|
|
Loading…
Reference in a new issue