extern/nix-config
1
0
Fork 1
mirror of https://github.com/donovanglover/nix-config.git synced 2024-12-16 11:51:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update READMEs for fish, git, and tmux

Browse Source 
This is the start of a process to change the old
READMEs to the new format.
This commit is contained in:
Donovan Glover 2018-11-19 21:58:18 -05:00
parent b3cc7f1ba5
commit 6ccf5d3352
No known key found for this signature in database
GPG Key ID: EA7408A77AE1BE65
3 changed files with 35 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
fish/README.md
View File

@ -1,22 +1,17 @@
# fish - the friendly interactive shell
# fish
I use fish as my default shell of choice, and write scripts in `sh`.
[fish][fish] is the friendly interactive shell.
## Dependencies
## Use Cases
- [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.)
fish can be used to:
## Installation
- Have syntax highlighting in the terminal with 0 configuration
- Have leading autocompletion in the terminal with 0 configuration
- Set abbreviations instead of aliases, making it easy to remember what aliases expand to
```sh
make package=fish
```
You should not use fish if:
## Usage
- You should use fish.
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/
[fish]: https://github.com/fish-shell/fish-shell

27
git/README.md
View File

@ -1,21 +1,26 @@
# Git
I use git as my main tool for distributed version control.
- [Git][git] is the standard version control tool.
## Dependencies
# Use Cases
- [git][git] - The standard version control system
- [diff-so-fancy][diff-so-fancy] - An amazing git diff utility
Git can be used to:
## Installation
- Keep track of file changes over time
- Keep a record of all contributors to a code base
- Rollback to a previous version of a project
- Create snapshots of a project with tags (also known as versions)
```sh
make package=git
```
You should not use Git if:
- You are dealing with binary files
- You are dealing with large files that change often
## Usage
Add a `.gituser` file to your `$HOME` with the following:
First, install [diff-so-fancy][diff-so-fancy], an amazing git diff utility.
Then, create a `~/.gituser` with the following:
```gitconfig
[user]
@ -24,5 +29,5 @@ Add a `.gituser` file to your `$HOME` with the following:
signingkey = <the subkey you use to sign git commits>
```
[git]: https://www.archlinux.org/packages/extra/x86_64/git/
[diff-so-fancy]: https://www.archlinux.org/packages/community/any/diff-so-fancy/
[git]: https://github.com/git/git
[diff-so-fancy]: https://github.com/so-fancy/diff-so-fancy

22
tmux/README.md
View File

@ -1,21 +1,17 @@
# tmux
I use tmux to run multiple shells inside a single terminal, in addition to all the other benefits that tmux provides, such as session management, persistent history, and detaching.
[tmux][tmux] is a terminal multiplexer.
## Dependencies
## Use Cases
- [tmux][tmux] - Terminal multiplexer
- [fish][fish] - The friendly interactive shell
tmux can be used to:
## Installation
- Have persistent history in the terminal
- Detach sessions and re-attach them later
- Work with multiple shells while SSH'd in another machine
```sh
make package=tmux
```
You should not use tmux if:
## Usage
- You should use tmux.
Start tmux as you normally would.
[tmux]: https://www.archlinux.org/packages/community/x86_64/tmux/
[fish]: https://www.archlinux.org/packages/community/x86_64/fish/
[tmux]: https://github.com/tmux/tmux