mjo
/
dotfiles
mirror of https://github.com/mjohanning99/dotfiles.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

Tecra-R940
Marvin Johanning 2020-03-30 16:22:52 +02:00
parent 4ecaaca333
commit bb952be895
1 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -3,16 +3,18 @@
<img src="scrot.png">
## What are dotfiles
Dotfiles get their name from the letter they start with, which is a dot. They are files that are hidden by default and often used for config files. However, I also other config files in this repository that aren't dotfiles.
## Why are these dotfiles here?
The advantage of using Gitlab to manage your config files is that you can go back to any change that has been made and, if needed, download the old version and replace it with a new, possibly broken, version on your computer. It can also be used to quickly download (or git clone) all config files you need to get started on a new computer. Lastly, it is a lot easier to share your always updated config files with other people.
Dotfiles are, generally, small files that, as the name would suggest, begin with a full-stop. These are generally used for the configuration of programs (especially CLI and TUI programs) and other parts of the operating system. Please be aware, however, that this repository also contains config files that technically _aren't_ dotfiles (as they don't begin with a dot). Therefore, it's best to view this repository as a collection of my most important config files.
## How can I use these files?
___Before you begin using these files, create a back-up of all your configuration files. Installing these may render your machine unsuable. Use at your own risk! I cannot be made responsible for any damage caused to your machine.___
If you wish to use these config files for yourself, I welcome you to do so! However, I use a couple of programs that you may not have installed and it's therefore important to install these before you begin.
Afterwards, you simply clone this repository and copy the content of the resulting folder into your `~` folder, overwriting exisiting files.
### Prerequisites
1. You need to have [i3-gaps](https://github.com/Airblader/i3) installed if you are planning on copying any of the files from the .i3 folder.
2. Vim is pre-installed on most Linux distributions, however I use Vim in the terminal. I am not sure if any of the configs work with gVim or neoVim or any of the other types of vim. (if you want to use my .vim configs)
* To install the different Vim plugins that I use, you will need to install Vundle which can be downloaded by typing `git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim` into your terminal. Afterwards, please try to run `:PluginInstall`; this should then automatically install the different plugins for you. Beware, however, that it may take a couple of seconds depending on your internet speed; it will say "Done!" when every plugin has been successfully downloaded.
3. Ranger is the file manager I use. I am not sure whether it comes pre-installed with most Linux distributions, so please check whether Ranger has been installed. (if you want to use my ranger configs)
4. [Pywal](https://github.com/dylanaraps/pywal) is highly recommended for changing backgrounds and colours on the fly (especially with my Ranger shortcut)
5. The mdv program
@ -21,9 +23,7 @@ The advantage of using Gitlab to manage your config files is that you can go bac
8. I prefer to use `termite`, as it seems to have much better UTF8 support
9. If you want to get the most out of `neomutt`, I highly recommend using mutt-wizard
10. I generally use Zsh as my default Shell
### Vim Plugins
To install the different Vim plugins that I use, you will need to install Vundle which can be downloaded by typing `git clone https://github.com/VundleVim/Vundle.vim.git ~/.vim/bundle/Vundle.vim` into your terminal. Afterwards, please try to run `:PluginInstall`; this should then automatically install the different plugins for you. Beware, however, that it may take a couple of seconds depending on your internet speed; it will say "Done!" when every plugin has been successfully downloaded.
* I use a couple of extensions. To install these, please first download and install `oh-my-zsh` and then download and install`autosuggestions` and `zsh-syntax-highlighting`. Otherwise you won't be able to use my .zshrc.
### How to get my set-up
In order to use these config files, you should firstly create a backup of your current config files (I recommend using git and Github for that as well. If that is too complicated, just rename them to something like configname.copy). After having created a backup of all important config files, you simply need to replace all all your files with the ones in this repository. Some config files have my username included, which means that if you try to run said config file you will most likely run into an error. Should you run into an error when running a config file or should something not work as intended, please check the config file and see if it includes my username and remove it.
@ -32,6 +32,7 @@ _**DISCLAIMER! USE AT OWN RISK!** I cannot be made responsible for any harm done
## Fonts
Fonts are not included in this repository. The font I use for my Terminal (URxvt) is Adobe's _Source Code Pro_. You will need to download that yourself using your package manager.
## Keybindings
These config files also include a large number of keybindings that have been tweaked or added to my liking. When using my configuration, please be aware that the keybindings that you are used to might have been changed.
Here is a quick overview of most of the commands that have been added