From 9ee790647211499a2eb8c2bc3033b4a87b1feb73 Mon Sep 17 00:00:00 2001 From: William Ting Date: Tue, 17 Apr 2012 20:38:49 -1000 Subject: [PATCH] fix documentation formatting --- Makefile | 4 ++-- README.md | 30 ++++++++++++++---------------- docs/{manpage.md => body.md} | 0 docs/install.md | 25 +++++++++++-------------- 4 files changed, 27 insertions(+), 32 deletions(-) rename docs/{manpage.md => body.md} (100%) diff --git a/Makefile b/Makefile index 09e855e..55f33d8 100644 --- a/Makefile +++ b/Makefile @@ -10,8 +10,8 @@ uninstall: uninstall.sh docs: - pandoc -s -w man docs/manpage_header.md docs/header.md docs/manpage.md -o docs/autojump.1 - pandoc -s -w markdown docs/header.md docs/install.md docs/manpage.md -o README.md + pandoc -s -w man docs/manpage_header.md docs/header.md docs/body.md -o docs/autojump.1 + pandoc -s -w markdown docs/header.md docs/install.md docs/body.md -o README.md release: # Check for tag existence diff --git a/README.md b/README.md index cbc9434..070b836 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,18 @@ INSTALLATION ### REQUIREMENTS -Python v2.7+ or 3.2+ - -Bash v4.0+ for tab completion +- Python v2.7+ or 3.2+ +- Bash v4.0+ for tab completion If you are unable to update Python to a supported version, older versions of autojump can be [downloaded](https://github.com/joelthelion/autojump/downloads) and installed manually. -Python v2.6+ is supported by [release -v19](https://github.com/downloads/joelthelion/autojump/autojump_v19.tar.gz). - -Python v2.4+ is supported by [release -v12](https://github.com/downloads/joelthelion/autojump/autojump_v12.tar.gz). +- Python v2.6+ is supported by [release + v19](https://github.com/downloads/joelthelion/autojump/autojump_v19.tar.gz). +- Python v2.4+ is supported by [release + v12](https://github.com/downloads/joelthelion/autojump/autojump_v12.tar.gz). ### AUTOMATIC INSTALLATION @@ -51,15 +49,15 @@ autojump is included in the following distro repositories, please use relevant package management utilities to install (e.g. yum, apt-get, etc): - - Debian testing/unstable, Ubuntu, Linux Mint - - On Debian only, autojump requires manual activation for policy reasons. Please see ``/usr/share/doc/autojump/README.Debian``. +- Debian\* testing/unstable, Ubuntu, Linux Mint +- RedHat, Fedora, CentOS +- ArchLinux +- Gentoo +- Frugalware +- Slackware - - RedHat, Fedora, CentOS - - ArchLinux - - Gentoo - - Frugalware - - Slackware +\* Requires manual activation for policy reasons, please see +`/usr/share/doc/autojump/README.Debian`. **Mac** diff --git a/docs/manpage.md b/docs/body.md similarity index 100% rename from docs/manpage.md rename to docs/body.md diff --git a/docs/install.md b/docs/install.md index e8d4676..1eab372 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,15 +2,13 @@ ### REQUIREMENTS -Python v2.7+ or 3.2+ - -Bash v4.0+ for tab completion +- Python v2.7+ or 3.2+ +- Bash v4.0+ for tab completion If you are unable to update Python to a supported version, older versions of autojump can be [downloaded][dl] and installed manually. -Python v2.6+ is supported by [release v19][v19]. - -Python v2.4+ is supported by [release v12][v12]. +- Python v2.6+ is supported by [release v19][v19]. +- Python v2.4+ is supported by [release v12][v12]. ### AUTOMATIC INSTALLATION @@ -18,15 +16,14 @@ Python v2.4+ is supported by [release v12][v12]. autojump is included in the following distro repositories, please use relevant package management utilities to install (e.g. yum, apt-get, etc): - - Debian testing/unstable, Ubuntu, Linux Mint - - On Debian only, autojump requires manual activation for policy reasons. Please see ``/usr/share/doc/autojump/README.Debian``. +- Debian\* testing/unstable, Ubuntu, Linux Mint +- RedHat, Fedora, CentOS +- ArchLinux +- Gentoo +- Frugalware +- Slackware - - RedHat, Fedora, CentOS - - ArchLinux - - Gentoo - - Frugalware - - Slackware +\* Requires manual activation for policy reasons, please see ``/usr/share/doc/autojump/README.Debian``. **Mac**