_ _
_____ ___ __ | | __ _(_)_ __
/ _ \ \/ / '_ \| |/ _` | | '_ \
| __/> <| |_) | | (_| | | | | |
\___/_/\_\ .__/|_|\__,_|_|_| |_|
|_|
https://uninformativ.de/git/explain
https://uninformativ.de/bugs.html
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
explain reads a simple markup language and allows you to annotate
commands using ASCII art, like this:
vim -p .bashrc .vimrc
\_/ | \____________/
| | |
| | \- Which files to open?
| |
| \- Open the files in tabs.
|
\- Open the editor.
Installation
------------
explain is a Python 3 script and requires no external libraries.
If you're on Arch Linux, you can use the following AUR package:
- https://aur.archlinux.org/packages/explain-git/
Running
-------
There's many ways to run the program. The most common one is to run it
on your terminal and specify required options:
$ explain <myfile
Refer to the manpage for all options.