From 8eace445a7206e3bce25b04812be0561bd9b7c28 Mon Sep 17 00:00:00 2001 From: William Ting Date: Thu, 6 Sep 2018 23:13:58 -0700 Subject: [PATCH] Clarify between first class and community supported items. --- README.md | 67 ++++++++++++++++++++++++++++++++----------------- docs/install.md | 64 ++++++++++++++++++++++++++++++---------------- 2 files changed, 86 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 6e838b9..495226a 100644 --- a/README.md +++ b/README.md @@ -63,29 +63,61 @@ INSTALLATION ### REQUIREMENTS -- Python v2.6+ or Python 3.3+ -- Supported shells: - - bash v4.0+ - - zsh - - fish - - tcsh (experimental) - - clink (Windows, experimental) +- Python v2.6+ or Python v3.3+ +- Supported shells + - bash - first class support + - zsh - first class support + - fish - community supported + - tcsh - community supported + - clink - community supported +- Supported platforms + - Linux - first class support + - OS X - first class support + - Windows - community supported + - BSD - community supported +- Supported installation methods + - source code - first class support + - Debian and derivatives - first class support + - ArchLinux / Gentoo / openSUSE / RedHat and derivatives - + community supported + - Homebrew / MacPorts - community supported + +Due to limited time and resources, only "first class support" items will +be maintained by the primary committers. All "community supported" items +will be updated based on pull requests submitted by the general public. + +Please continue opening issues and providing feedback for community +supported items since consolidating information helps other users +troubleshoot and submit enhancements and fixes. + +### MANUAL + +Grab a copy of autojump: + + git clone git://github.com/wting/autojump.git + +Run the installation script and follow on screen instructions. + + cd autojump + ./install.py or ./uninstall.py ### AUTOMATIC #### Linux autojump is included in the following distro repositories, please use -relevant package management utilities to install (e.g. yum, apt-get, -etc): +relevant package management utilities to install (e.g. apt-get, yum, +pacman, etc): - Debian, Ubuntu, Linux Mint All Debian-derived distros require manual activation for policy reasons, please see `/usr/share/doc/autojump/README.Debian`. -- RedHat, Fedora, CentOS (install `autojump-zsh` for zsh, - `autojump-fish` for fish, etc.) +- RedHat, Fedora, CentOS + + Install `autojump-zsh` for zsh, `autojump-fish` for fish, etc. + - ArchLinux - Gentoo - Frugalware @@ -97,7 +129,7 @@ Homebrew is the recommended installation method for Mac OS X: brew install autojump -MacPorts also available: +MacPorts is also available: port install autojump @@ -107,17 +139,6 @@ Windows Windows support is enabled by [clink](https://mridgers.github.io/clink/) which should be installed prior to installing autojump. -### MANUAL - -Grab a copy of autojump: - - git clone git://github.com/wting/autojump.git - -Run the installation script and follow on screen instructions. - - cd autojump - ./install.py or ./uninstall.py - KNOWN ISSUES ------------ diff --git a/docs/install.md b/docs/install.md index 0d0aac9..d4e4867 100644 --- a/docs/install.md +++ b/docs/install.md @@ -2,28 +2,59 @@ ### REQUIREMENTS -- Python v2.6+ or Python 3.3+ -- Supported shells: - - bash v4.0+ - - zsh - - fish - - tcsh (experimental) - - clink (Windows, experimental) +- Python v2.6+ or Python v3.3+ +- Supported shells + - bash - first class support + - zsh - first class support + - fish - community supported + - tcsh - community supported + - clink - community supported +- Supported platforms + - Linux - first class support + - OS X - first class support + - Windows - community supported + - BSD - community supported +- Supported installation methods + - source code - first class support + - Debian and derivatives - first class support + - ArchLinux / Gentoo / openSUSE / RedHat and derivatives - community supported + - Homebrew / MacPorts - community supported + +Due to limited time and resources, only "first class support" items will be +maintained by the primary committers. All "community supported" items will be +updated based on pull requests submitted by the general public. + +Please continue opening issues and providing feedback for community supported +items since consolidating information helps other users troubleshoot and submit +enhancements and fixes. + +### MANUAL + +Grab a copy of autojump: + + git clone git://github.com/wting/autojump.git + +Run the installation script and follow on screen instructions. + + cd autojump + ./install.py or ./uninstall.py ### AUTOMATIC #### Linux autojump is included in the following distro repositories, please use relevant -package management utilities to install (e.g. yum, apt-get, etc): +package management utilities to install (e.g. apt-get, yum, pacman, etc): - Debian, Ubuntu, Linux Mint All Debian-derived distros require manual activation for policy reasons, please see `/usr/share/doc/autojump/README.Debian`. -- RedHat, Fedora, CentOS (install `autojump-zsh` for zsh, `autojump-fish` for - fish, etc.) +- RedHat, Fedora, CentOS + + Install `autojump-zsh` for zsh, `autojump-fish` for fish, etc. + - ArchLinux - Gentoo - Frugalware @@ -35,7 +66,7 @@ Homebrew is the recommended installation method for Mac OS X: brew install autojump -MacPorts also available: +MacPorts is also available: port install autojump @@ -43,14 +74,3 @@ MacPorts also available: Windows support is enabled by [clink](https://mridgers.github.io/clink/) which should be installed prior to installing autojump. - -### MANUAL - -Grab a copy of autojump: - - git clone git://github.com/wting/autojump.git - -Run the installation script and follow on screen instructions. - - cd autojump - ./install.py or ./uninstall.py