From 03ed2a43a1a80c69d1a9590e3e04fdb9317791ff Mon Sep 17 00:00:00 2001 From: nfnty Date: Mon, 16 Jan 2017 00:55:16 +0100 Subject: Documentation: Improve readability --- README.md | 75 ++++++++++++++++++++++++++++++++++----------------------------- 1 file changed, 40 insertions(+), 35 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index b1512797..d1a1da25 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,29 @@ ranger v.1.8.1 ranger is a console file manager with VI key bindings. It provides a minimalistic and nice curses interface with a view on the directory hierarchy. -It ships with "rifle", a file launcher that is good at automatically finding +It ships with `rifle`, a file launcher that is good at automatically finding out which program to use for what file type. ![screenshot](https://raw.githubusercontent.com/ranger/ranger-assets/master/screenshots/screenshot.png) This file describes ranger and how to get it to run. For instructions on the -usage, please read the man page. See HACKING.md for development specific -information. For configuration, check the files in ranger/config/ or copy the -default config to ~/.config/ranger with ranger's --copy-config option. The -examples/ directory contains several scripts and plugins that demonstrate how +usage, please read the man page. See `HACKING.md` for development specific +information. + +For configuration, check the files in `ranger/config/` or copy the +default config to `~/.config/ranger` with `ranger --copy-config`. + +The `examples/` directory contains several scripts and plugins that demonstrate how ranger can be extended or combined with other programs. These files can be -found in the git repository or in /usr/share/doc/ranger. +found in the git repository or in `/usr/share/doc/ranger`. -A note to packagers: Versions meant for packaging are listed in the changelog +A note to packagers: Versions meant for packaging are listed in the changelog on the website. About ----- -* Authors: see "AUTHORS" file +* Authors: see `AUTHORS` file * License: GNU General Public License Version 3 * Website: http://ranger.nongnu.org/ * Download: http://ranger.nongnu.org/ranger-stable.tar.gz @@ -50,59 +53,61 @@ Features * VIM-like console and hotkeys * Automatically determine file types and run them with correct programs * Change the directory of your shell after exiting ranger -* Tabs, Bookmarks, Mouse support +* Tabs, bookmarks, mouse support Dependencies ------------ -* Python (tested with version 2.6, 2.7, 3.1-3.5) with the "curses" module +* Python (tested with version 2.6, 2.7, 3.1-3.5) with the `curses` module and (optionally) wide-unicode support. -* A pager ("less" by default) +* A pager (`less` by default) Optional: -* The "file" program for determining file types -* The python module "chardet", in case of encoding detection problems -* "sudo" to use the "run as root"-feature -* w3m for the "w3mimgdisplay" program to preview images +* The `file` program for determining file types +* The python module `chardet`, in case of encoding detection problems +* `sudo` to use the "run as root"-feature +* `w3m` for the `w3mimgdisplay` program to preview images -Optional, for enhanced file previews (with "scope.sh"): +Optional, for enhanced file previews (with `scope.sh`): -* img2txt (from caca-utils) for ASCII-art image previews -* highlight or pygmentize for syntax highlighting of code -* atool, acat, bsdtar and/or unrar for previews of archives -* lynx, w3m or elinks for previews of html pages -* pdftotext for pdf previews -* transmission-show for viewing bit-torrent information -* mediainfo or exiftool for viewing information about media files -* odt2txt for OpenDocument text files (odt, ods, odp and sxw) +* `img2txt` (from `caca-utils`) for ASCII-art image previews +* `highlight` or `pygmentize` for syntax highlighting of code +* `atool`, `acat`, `bsdtar` and/or `unrar` for previews of archives +* `lynx`, `w3m` or `elinks` for previews of html pages +* `pdftotext` for pdf previews +* `transmission-show` for viewing bit-torrent information +* `mediainfo` or `exiftool` for viewing information about media files +* `odt2txt` for OpenDocument text files (`odt`, `ods`, `odp` and `sxw`) Installing ---------- Use the package manager of your operating system to install ranger. -Note that ranger can be started without installing by simply running ranger.py. +Note that ranger can be started without installing by simply running `ranger.py`. To install ranger manually: - - sudo make install +``` +sudo make install +``` This translates roughly to: +``` +sudo python setup.py install --optimize=1 --record=install_log.txt +``` - sudo python setup.py install --optimize=1 --record=install_log.txt - -This also saves a list of all installed files to install_log.txt, which you can +This also saves a list of all installed files to `install_log.txt`, which you can use to uninstall ranger. Getting Started --------------- -After starting ranger, you can use the Arrow Keys (or hjkl) to navigate, Enter -to open a file or type Q to quit. The third column shows a preview of the +After starting ranger, you can use the Arrow Keys or `h` `j` `k` `l` to navigate, `Enter` +to open a file or type `Q` to quit. The third column shows a preview of the current file. The second is the main column and the first shows the parent directory. -Ranger can automatically copy default configuration files to ~/.config/ranger -if you run it with the switch --copy-config. (see ranger --help for a -description of that switch.) Also check ranger/config/ for the default +Ranger can automatically copy default configuration files to `~/.config/ranger` +if you run it with the switch `--copy-config`. See `ranger --help` for a +description of that switch. Also check `ranger/config/` for the default configuration. -- cgit 1.4.1-2-gfad0