mirror of
https://github.com/donovanglover/nix-config.git
synced 2024-11-08 17:34:03 +01:00
docs: Update README
Fixed some typos and decreased the amount of repetitive information.
This commit is contained in:
parent
082f64f763
commit
700d99ae7c
32
README.md
32
README.md
@ -4,30 +4,24 @@
|
||||
|
||||
## Usage
|
||||
|
||||
### Step 1. Install `stow`
|
||||
### Step 0. Clone this repository
|
||||
|
||||
- Arch Linux: `pacman -S stow`
|
||||
- Fedora: `dnf install stow`
|
||||
- `git clone https://github.com/GloverDonovan/dotfiles.git --depth 1`
|
||||
|
||||
If you are using a different [GNU/Linux][gnulinux] operating system, most
|
||||
(if not all) of the files should work, but I will not provide support for
|
||||
those distributions.
|
||||
### Step 1. Install [stow][stow]
|
||||
|
||||
If you are using a [non-free][freesw] operating system, I recommend
|
||||
[Fedora][fedora]. If you want to mimic my bspwm setup, you probably want
|
||||
[Arch Linux][archlinux] instead.
|
||||
- [Arch Linux][archlinux]: `pacman -S stow`
|
||||
- [Fedora][fedora]: `dnf install stow`
|
||||
|
||||
### Step 2. Install the dotfiles you want
|
||||
|
||||
For example, to use my vim config, run:
|
||||
|
||||
```shell
|
||||
```sh
|
||||
make package=vim
|
||||
```
|
||||
|
||||
None of your dotfiles will be overridden. If you already have a `.vimrc`,
|
||||
stow will not override it. The same rule applies for any dotfiles you try
|
||||
to install.
|
||||
Since my dotfiles are managed with Stow, any of your existing dotfiles will not be overridden or changed.
|
||||
|
||||
## List of dotfiles
|
||||
|
||||
@ -38,8 +32,8 @@ to install.
|
||||
- [fish](/fish) - My settings for fish, the friendly interactive shell.
|
||||
- [git](/git) - The standard version control tool.
|
||||
- [gpg](/gpg) - My settings for GPG.
|
||||
- [plasma](/plasma) - Dofiles specific to KDE Plasma.
|
||||
- [systemd](/systemd) - User services, such as ssh-agent and urxvtc.
|
||||
- [plasma](/plasma) - Dotfiles specific to KDE Plasma.
|
||||
- [systemd](/systemd) - User services, such as ssh-agent and urxvtd.
|
||||
- [term](/term) - Config for urxvt and termite. May apply elsewhere as well.
|
||||
- [tmux](/tmux) - A vim-like terminal multiplexer that gets out of your way.
|
||||
- [vim](/vim) - The settings I use for vim, also known as the best editor.
|
||||
@ -48,17 +42,15 @@ to install.
|
||||
|
||||
## Uninstall
|
||||
|
||||
If you don't want to use some of my dotfiles anymore, they can be easily
|
||||
uninstalled without removing any of your other files.
|
||||
If you don't want to use some of my dotfiles anymore, they can be easily uninstalled.
|
||||
|
||||
For example, if you don't want to use my `.vimrc` anymore, run:
|
||||
|
||||
```
|
||||
```sh
|
||||
make uninstall package=vim
|
||||
```
|
||||
|
||||
This will remove only my vim files from your system, while keeping your other
|
||||
files intact. Stow will only remove what it owns.
|
||||
This will only remove the files that Stow owns, while keeping your other files intact.
|
||||
|
||||
[archlinux]: https://www.archlinux.org
|
||||
[fedora]: https://getfedora.org
|
||||
|
Loading…
Reference in New Issue
Block a user