Skip to content

Commit b581fd5

Browse files
committed
Minor tweak to description and layout
1 parent 375136b commit b581fd5

File tree

2 files changed

+17
-6
lines changed

2 files changed

+17
-6
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,13 @@ cmd2: a tool for building interactive command line apps
66
[![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/master/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
77
[![Documentation Status](https://readthedocs.org/projects/cmd2/badge/?version=latest)](http://cmd2.readthedocs.io/en/latest/?badge=latest)
88

9-
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.
9+
cmd2 is a tool for building interactive command line applications in Python. Its goal is to make it
10+
quick and easy for developers to build feature-rich and user-friendly interactive command line
11+
applications. It provides a simple API which is an extension of Python's built-in
12+
[cmd](https://docs.python.org/3/library/cmd.html) module. cmd2 provides a wealth of features on top
13+
of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
14+
when using cmd.
15+
1016

1117
Main Features
1218
-------------
@@ -29,6 +35,7 @@ Main Features
2935
- Trivial to provide built-in help for all commands
3036
- Built-in regression testing framework for your applications (transcript-based testing)
3137

38+
3239
Installation
3340
------------
3441
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
3744
pip install -U cmd2
3845
```
3946

40-
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),
41-
and [pyperclip](https://github.com/asweigart/pyperclip).
47+
cmd2 works with Python 2.7 and Python 3.3+ on Windows, macOS, and Linux. It is pure Python code with
48+
the only 3rd-party dependencies being on [six](https://pypi.python.org/pypi/six),
49+
[pyparsing](http://pyparsing.wikispaces.com), and [pyperclip](https://github.com/asweigart/pyperclip).
50+
51+
For information on other installation options, see
52+
[Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2
53+
documentation.
4254

43-
For information on other installation options, see [Installation Instructions](https://cmd2.readthedocs.io/en/latest/install.html) in the cmd2 documentation.
4455

4556
Documentation
4657
-------------
@@ -49,7 +60,6 @@ The latest documentation for cmd2 can be read online here: https://cmd2.readthed
4960
It is available in HTML, PDF, and ePub formats.
5061

5162

52-
5363
Feature Overview
5464
----------------
5565
Instructions for implementing each feature follow.
@@ -107,6 +117,7 @@ A couple tutorials on using cmd2 exist:
107117
* A nice brief step-by-step tutorial
108118
* https://kushaldas.in/posts/developing-command-line-interpreters-using-python-cmd2.html
109119

120+
110121
Example Application
111122
-------------------
112123

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
LONG_DESCRIPTION = """cmd2 is a tool for building interactive command line applications in Python. Its goal is to make
1111
it quick and easy for developers to build feature-rich and user-friendly interactive command line applications. It
1212
provides a simple API which is an extension of Python's built-in cmd module. cmd2 provides a wealth of features on top
13-
of cmd to make your life easier.
13+
of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary when using cmd.
1414
1515
The latest documentation for cmd2 can be read online here:
1616
https://cmd2.readthedocs.io/

0 commit comments

Comments
 (0)