diff options
author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-02-12 21:39:15 -0500 |
---|---|---|
committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2017-02-12 21:39:15 -0500 |
commit | f3d54b866eee233ffa6d0a5f7aa054fe01d10805 (patch) | |
tree | 6191ba287b9a3ec79ac691c1a29602dc8d9d5d29 /docs | |
parent | 2b049c4db4350f05f00cb290d132cbf95de36c66 (diff) | |
download | cmd2-git-f3d54b866eee233ffa6d0a5f7aa054fe01d10805.tar.gz |
Added installation instructions to documentation.
Also reorganized the GitHub README.rst front-page.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 1 | ||||
-rw-r--r-- | docs/install.rst | 84 |
2 files changed, 85 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index ce295be7..666f202e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -59,6 +59,7 @@ Contents: .. toctree:: :maxdepth: 2 + install overview freefeatures settingchanges diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 00000000..8a9d3791 --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,84 @@ + +========================= +Installation Instructions +========================= + +This section covers the basics of how to install, upgrade, and uninstall ``cmd2``. + +Installing +---------- +First you need to make sure you have Python 2.7 or Python 3.3+, pip_, and setuptools_. Then you can just use pip to +install from PyPI_. + +.. _pip: https://pypi.python.org/pypi/pip +.. _setuptools: https://pypi.python.org/pypi/setuptools +.. _PyPI: https://pypi.python.org/pypi + +Requirements for Installing +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* If you have Python 2 >=2.7.9 or Python 3 >=3.4 installed from `python.org + <https://www.python.org>`_, you will already have pip_ and + setuptools_, but may need to upgrade to the latest versions: + + On Linux or OS X: + + :: + + pip install -U pip setuptools + + + On Windows: + + :: + + python -m pip install -U pip setuptools + + +Use pip for Installing +~~~~~~~~~~~~~~~~~~~~~~ + +pip_ is the recommended installer. Installing with pip is easy:: + + pip install cmd2 + +This should also install the required 3rd-party dependencies, if necessary. + + +Install from Debian or Ubuntu repos +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +We recommend installing from pip_, but if you wish to install from Debian or Ubuntu repos this can be done with +apt-get. + +For Python 2:: + + sudo apt-get install python-cmd2 + +For Python 3:: + + sudo apt-get install python3-cmd2 + +This will also install the required 3rd-party dependencies. + + +Deploy cmd2.py with your project +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +This is an option suitable for advanced Python users. The ``cmd2`` module is a single file, **cmd2.py**. You can +simply include this file within your project's hierarchy. If you want to modify ``cmd2``, this may be a reasonable +option. Though, we would encourage you to use stock ``cmd2`` and inheritance to achieve the same goal. + + +Upgrading cmd2 +-------------- + +Upgrade an already installed ``cmd2`` to the latest version from PyPI_:: + + pip install -U cmd2 + +This will upgrade to the newest stable version of ``cmd2`` and will also upgrade any dependencies if necessary. + + +Uninstalling cmd2 +----------------- +If you wish to permanently uninstall ``cmd2``, this can also easily be done with pip_:: + + pip uninstall cmd2 |