summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTodd Leonhardt <todd.leonhardt@gmail.com>2017-07-03 14:29:27 -0400
committerTodd Leonhardt <todd.leonhardt@gmail.com>2017-07-03 14:29:27 -0400
commitb581fd53ee6ae6c478eacbaa79cac9fcb68f6d76 (patch)
treecb95834d03ba4f091b09c80e971c4e21dd8d5c44 /README.md
parent375136b196b177e19cb4b82d8a212bf4d298acf2 (diff)
downloadcmd2-git-b581fd53ee6ae6c478eacbaa79cac9fcb68f6d76.tar.gz
Minor tweak to description and layout
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md21
1 files changed, 16 insertions, 5 deletions
diff --git a/README.md b/README.md
index 0e032320..805ce5d6 100755
--- a/README.md
+++ b/README.md
@@ -6,7 +6,13 @@ cmd2: a tool for building interactive command line apps
[![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/master/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
[![Documentation Status](https://readthedocs.org/projects/cmd2/badge/?version=latest)](http://cmd2.readthedocs.io/en/latest/?badge=latest)
-cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it quick and easy for developers to build feature-rich and user-friendly interactive command line applications. It provides a simple API which is an extension of Python's built-in [cmd](https://docs.python.org/3/library/cmd.html) module. cmd2 provides a wealth of features on top of cmd to make your life easier.
+cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it
+quick and easy for developers to build feature-rich and user-friendly interactive command line
+applications. It provides a simple API which is an extension of Python's built-in
+[cmd](https://docs.python.org/3/library/cmd.html) module. cmd2 provides a wealth of features on top
+of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
+when using cmd.
+
Main Features
-------------
@@ -29,6 +35,7 @@ Main Features
- Trivial to provide built-in help for all commands
- Built-in regression testing framework for your applications (transcript-based testing)
+
Installation
------------
On all operating systems, the latest stable version of `cmd2` can be installed using pip:
@@ -37,10 +44,14 @@ On all operating systems, the latest stable version of `cmd2` can be installed u
pip install -U cmd2
```
-cmd2 works with Python 2.7 and Python 3.3+ on Windows, macOS, and Linux. It is pure Python code with the only 3rd-party dependencies being on [six](https://pypi.python.org/pypi/six), [pyparsing](http://pyparsing.wikispaces.com),
-and [pyperclip](https://github.com/asweigart/pyperclip).
+cmd2 works with Python 2.7 and Python 3.3+ on Windows, macOS, and Linux. It is pure Python code with
+the only 3rd-party dependencies being on [six](https://pypi.python.org/pypi/six),
+[pyparsing](http://pyparsing.wikispaces.com), and [pyperclip](https://github.com/asweigart/pyperclip).
+
+For information on other installation options, see
+[Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2
+documentation.
-For information on other installation options, see [Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2 documentation.
Documentation
-------------
@@ -49,7 +60,6 @@ The latest documentation for cmd2 can be read online here: https://cmd2.readthed
It is available in HTML, PDF, and ePub formats.
-
Feature Overview
----------------
Instructions for implementing each feature follow.
@@ -107,6 +117,7 @@ A couple tutorials on using cmd2 exist:
* A nice brief step-by-step tutorial
* https://kushaldas.in/posts/developing-command-line-interpreters-using-python-cmd2.html
+
Example Application
-------------------