.dotfiles/README.md

22 lines
1 KiB
Markdown

# My Dotfiles
The collection of my precious dotfiles.
## Installation
To install run this command:
```
git clone https://github.com/saibotk/.dotfiles ~/; cd ~/.dotfiles; ./install
```
This should install all dependecies and create symlinks to all needed files. The only thing that you have to setup on your own is `nvim`.
## Customization
It is possible to load your own zsh-plugins and other commands you want to execute in the `.zshrc`. To add zsh-plugins add a `plugins` file to `~/.dotfiles/shell/`. An example is provided in `~/.dotfiles/shell/plugins.example`. The same thing applies to commands you want to execute in on shell startup, just add a `localcommands` file with your commands in `~/.dotfiles/shell/`.
## Atom packages
If you plan on using you own atom package list, you can modify the "atom/packages.list".
The install script will try to find that file and automatically install all packages.
You can export the package list with:
```
apm list --installed --bare > ~/.dotfiles/.atom/packages.list
```