Clarify between first class and community supported items.

XhinLiang · Sep 7, 2018 · 8eace44 · 8eace44
1 parent 26c81fc
commit 8eace44
Show file tree

Hide file tree

Showing 2 changed files with 86 additions and 45 deletions.
diff --git 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
@@ -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,22 +66,11 @@ Homebrew is the recommended installation method for Mac OS X:
 
     brew install autojump
 
-MacPorts also available:
+MacPorts is also available:
 
     port install autojump
 
 ## 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