extern/nix-config
1
0
Fork 1
mirror of https://github.com/donovanglover/nix-config.git synced 2025-06-19 17:28:49 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README

Browse Source 
Fixed some typos and decreased the amount of repetitive information.
This commit is contained in:
Donovan Glover 2018-10-30 11:22:45 -04:00
parent 082f64f763
commit 700d99ae7c
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
1 changed files with 12 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -4,30 +4,24 @@
## Usage ## Usage
### Step 1. Install `stow` ### Step 0. Clone this repository
- Arch Linux: `pacman -S stow` - `git clone https://github.com/GloverDonovan/dotfiles.git --depth 1`
- Fedora: `dnf install stow`
If you are using a different [GNU/Linux][gnulinux] operating system, most ### Step 1. Install [stow][stow]
(if not all) of the files should work, but I will not provide support for
those distributions.
If you are using a [non-free][freesw] operating system, I recommend - [Arch Linux][archlinux]: `pacman -S stow`
[Fedora][fedora]. If you want to mimic my bspwm setup, you probably want - [Fedora][fedora]: `dnf install stow`
[Arch Linux][archlinux] instead.
### Step 2. Install the dotfiles you want ### Step 2. Install the dotfiles you want
For example, to use my vim config, run: For example, to use my vim config, run:
```shell ```sh
make package=vim make package=vim
``` ```
None of your dotfiles will be overridden. If you already have a `.vimrc`, Since my dotfiles are managed with Stow, any of your existing dotfiles will not be overridden or changed.
stow will not override it. The same rule applies for any dotfiles you try
to install.
## List of dotfiles ## List of dotfiles
@ -38,8 +32,8 @@ to install.
- [fish](/fish) - My settings for fish, the friendly interactive shell. - [fish](/fish) - My settings for fish, the friendly interactive shell.
- [git](/git) - The standard version control tool. - [git](/git) - The standard version control tool.
- [gpg](/gpg) - My settings for GPG. - [gpg](/gpg) - My settings for GPG.
- [plasma](/plasma) - Dofiles specific to KDE Plasma. - [plasma](/plasma) - Dotfiles specific to KDE Plasma.
- [systemd](/systemd) - User services, such as ssh-agent and urxvtc. - [systemd](/systemd) - User services, such as ssh-agent and urxvtd.
- [term](/term) - Config for urxvt and termite. May apply elsewhere as well. - [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. - [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. - [vim](/vim) - The settings I use for vim, also known as the best editor.
@ -48,17 +42,15 @@ to install.
## Uninstall ## Uninstall
If you don't want to use some of my dotfiles anymore, they can be easily If you don't want to use some of my dotfiles anymore, they can be easily uninstalled.
uninstalled without removing any of your other files.
For example, if you don't want to use my `.vimrc` anymore, run: For example, if you don't want to use my `.vimrc` anymore, run:
``` ```sh
make uninstall package=vim make uninstall package=vim
``` ```
This will remove only my vim files from your system, while keeping your other This will only remove the files that Stow owns, while keeping your other files intact.
files intact. Stow will only remove what it owns.
[archlinux]: https://www.archlinux.org [archlinux]: https://www.archlinux.org
[fedora]: https://getfedora.org [fedora]: https://getfedora.org