Archives/wting_autojump
1
0
Fork 0
mirror of https://github.com/wting/autojump synced 2024-10-27 20:34:07 +00:00
Code Issues Releases Wiki Activity

fix documentation formatting

Browse Source
This commit is contained in:
William Ting 2012-04-17 20:38:49 -10:00
parent f91c7e3954
commit 9ee7906472
4 changed files with 27 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@ -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

30
README.md
View File

@ -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
- Debian\* testing/unstable, Ubuntu, Linux Mint
- RedHat, Fedora, CentOS
- ArchLinux
- Gentoo
- Frugalware
- Slackware
On Debian only, autojump requires manual activation for policy reasons. Please see ``/usr/share/doc/autojump/README.Debian``.
- RedHat, Fedora, CentOS
- ArchLinux
- Gentoo
- Frugalware
- Slackware
\* Requires manual activation for policy reasons, please see
`/usr/share/doc/autojump/README.Debian`.
**Mac**

0
docs/manpage.md → docs/body.md
View File

25
docs/install.md
View File

@ -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
- Debian\* testing/unstable, Ubuntu, Linux Mint
- RedHat, Fedora, CentOS
- ArchLinux
- Gentoo
- Frugalware
- Slackware
On Debian only, autojump requires manual activation for policy reasons. Please see ``/usr/share/doc/autojump/README.Debian``.
- RedHat, Fedora, CentOS
- ArchLinux
- Gentoo
- Frugalware
- Slackware
\* Requires manual activation for policy reasons, please see ``/usr/share/doc/autojump/README.Debian``.
**Mac**