forked from extern/nix-config
misc: Update docs
Made dependency lists a bit more consistent and reverted some of the Arch Linux wording since it felt a bit off. Even the official website refers to Arch Linux as Arch from time to time.
This commit is contained in:
parent
2fa91642d3
commit
f3d129362e
@ -1,12 +1,12 @@
|
||||
# Tari - A bspwm rice featuring HiDPI support with KDE applications
|
||||
# Tari - A bspwm + KDE rice with HiDPI support
|
||||
|
||||
I use [Arch Linux][archlinux], a [GNU/Linux][gnulinux] distribution, for its bare-bones setup out of the box. This makes it easy to customize and control, since you only install what you need. This guide covers replicating my [bspwm](/bspwm) setup on your Arch Linux machine.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Step 1. Install Arch Linux
|
||||
### Step 1. Install Arch
|
||||
|
||||
Install Arch Linux like you normally would, following the [Installation guide][archguide]. Although I keep some of my install scripts in this directory, the actual installation process varies depending on your hardware and which setup you're trying to achieve. For this reason, my scripts should only be used as a guide *after* you have a proficient understanding of how Arch Linux works.
|
||||
Install Arch like you normally would, following the [Installation guide][archguide]. Although I keep some of my install scripts in this directory, the actual installation process varies depending on your hardware and which setup you're trying to achieve. For this reason, my scripts should only be used as a guide *after* you have a proficient understanding of how Arch Linux works.
|
||||
|
||||
### Step 2. Install packages
|
||||
|
||||
|
10
README.md
10
README.md
@ -6,7 +6,11 @@
|
||||
|
||||
### Step 0. Clone this repository
|
||||
|
||||
- `git clone https://github.com/GloverDonovan/dotfiles.git --depth 1`
|
||||
Add `--depth 1` to only fetch the latest commit.
|
||||
|
||||
```sh
|
||||
git clone https://github.com/GloverDonovan/dotfiles.git --depth 1
|
||||
```
|
||||
|
||||
### Step 1. Install [stow][stow]
|
||||
|
||||
@ -40,9 +44,7 @@ Since my dotfiles are managed with Stow, any of your existing dotfiles will not
|
||||
|
||||
## Uninstall
|
||||
|
||||
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:
|
||||
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
|
||||
|
@ -4,8 +4,8 @@ I use fish as my default shell of choice, and write scripts in `sh`.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `fish` - The friendly interactive shell
|
||||
- `exa` - Drop-in replacement for `ls` and `tree`
|
||||
- [fish][fish] - The friendly interactive shell
|
||||
- [exa][exa] - Drop-in replacement for `ls` and `tree`
|
||||
- Any other features that you want to use (git abbreviations, etc.)
|
||||
|
||||
## Installation
|
||||
@ -17,3 +17,6 @@ make package=fish
|
||||
## Usage
|
||||
|
||||
The dotfiles are automatically applied when you start fish.
|
||||
|
||||
[fish]: https://www.archlinux.org/packages/community/x86_64/fish/
|
||||
[exa]: https://www.archlinux.org/packages/community/x86_64/exa/
|
||||
|
@ -4,7 +4,7 @@ GPG is used to sign and encrypt things.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- [`gnupg`][gnupg] - The GNU Privacy Guard
|
||||
- [gnupg][gnupg] - The GNU Privacy Guard
|
||||
|
||||
## Installation
|
||||
|
||||
|
@ -4,13 +4,13 @@ I use neovim as my main text editor, and vim elsewhere.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- `vim` - If you're reading this, you probably already know what vim is
|
||||
- `neovim` - An improved version of vim (cursor modes, sane defaults, etc.)
|
||||
- `wal` - Changing color schemes support
|
||||
- `fzf` - Fuzzy search support
|
||||
- `ripgrep` - Jump between lines in files
|
||||
- `git` - Git diff support
|
||||
- Any other features you want to use (e.g. TeX support with `texlive`)
|
||||
- [vim][vim] - If you're reading this, you probably already know what vim is
|
||||
- [neovim][neovim] - An improved version of vim (cursor modes, sane defaults, etc.)
|
||||
- [python-pywal][python-pywal] - Changing color schemes support
|
||||
- [fzf][fzf] - Fuzzy search support
|
||||
- [ripgrep][ripgrep] - Jump between lines in files
|
||||
- [git][git] - Git diff support
|
||||
- Any other features you want to use (e.g. TeX support with [texlive-core][texlive-core])
|
||||
|
||||
## Installation
|
||||
|
||||
@ -23,3 +23,10 @@ make package=vim
|
||||
I use [vim-plug][vim-plug] as my plugin manager of choice. If it isn't installed already, my `.vimrc` will install it for you. If you already have vim-plug installed, run `:PlugInstall`. Now you can use my vim config with all the plugins enabled!
|
||||
|
||||
[vim-plug]: https://github.com/junegunn/vim-plug
|
||||
[vim]: https://www.archlinux.org/packages/extra/x86_64/vim/
|
||||
[neovim]: https://www.archlinux.org/packages/community/x86_64/neovim/
|
||||
[python-pywal]: https://www.archlinux.org/packages/community/any/python-pywal/
|
||||
[fzf]: https://www.archlinux.org/packages/community/x86_64/fzf/
|
||||
[ripgrep]: https://www.archlinux.org/packages/community/x86_64/ripgrep/
|
||||
[git]: https://www.archlinux.org/packages/extra/x86_64/git/
|
||||
[texlive-core]: https://www.archlinux.org/packages/extra/any/texlive-core/
|
||||
|
Loading…
Reference in New Issue
Block a user