mirror of
https://github.com/ItsDrike/dotfiles.git
synced 2024-11-10 10:39:41 +00:00
52 lines
3.6 KiB
Markdown
52 lines
3.6 KiB
Markdown
# Dotfiles
|
|
|
|
These are my personal dotfiles. This also include an automated installer for certain packages (Arch Linux specific) and for putting the dotfiles in place.
|
|
Source code for this automated script is in `src` directory, and the dotfiles are located in `home` and `root` directories respectively.
|
|
|
|
You are highly adviced to first go through these dotfiles yourself and adjust them to your liking.
|
|
|
|
## What does it do
|
|
|
|
- Fully 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/.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](home/.config/sh/theme), both for oh-my-zsh configuration or for standalone usage
|
|
- Custom [VIM configuration](home/.config/vim/vimrc) (this was designed for regular vim, nvim support can't be guaranteed)
|
|
- Many handy [aliases](home/.config/sh/aliases) (likely too many, you should adjust that to your needs)
|
|
- [XDG configuration](home/.config/sh/environ) to avoid too much cluttering in home directory
|
|
- [Automatic handlers](home/.config/sh/handlers) which override default command not found behavior to show the package to which given command belongs (requires pkgfile on Arch Linux)
|
|
- Automated package installation for Arch Linux, which includes many handy packages. You should certainly take a look at which packages will be installed and adjust [`packages.yaml`](packages.yaml) before you run it.
|
|
- Extensive [vscode settings](home/.config/Code/User/settings.json), note that these are the settings which I like, you will probably want to adjust them to your personal needs, or perhaps even replace them
|
|
|
|
## Requirements
|
|
|
|
`curl` and `tar`, or `git` to clone the repository itself.
|
|
Installation uses `python` and `pip` and `pyyaml` library for python, but that will get installed automatically by the `install.sh` script.
|
|
|
|
## Sample images
|
|
|
|
- Prompt (Fully adjustable, either manually [here](home/.config/sh/theme), or using other oh-my-zsh themes and removing the custom theme from `.zshrc`) 
|
|
- Vim configuration (Fully adjustable, simply edit [`vimrc`](home/.config/vim/vimrc)) 
|
|
- Automatic unknown command package handler 
|
|
|
|
## 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]`
|
|
|
|
## Running the script
|
|
|
|
Before you run, you should take a look at the files included and adjust them however you like.
|
|
|
|
- All files which will be added are in [`home/`](home) and [`root/`](root) directory. You can remove files which you don't want, or adjust them in any way.
|
|
- You should also take a look at [`packages.yaml`](packages.yaml) and remove all packages which you don't want and add those you do.
|
|
|
|
When you are prepared, you can run the installer (assuming you're in the clonned directory):
|
|
`$ chmod +x install.sh` (Make installation script executable)
|
|
`$ sh install.sh` (run the installation script, which will begin the instalaltion)
|