summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CONTRIBUTING.md10
-rwxr-xr-xREADME.md2
-rw-r--r--cmd2.pngbin0 -> 294386 bytes
-rwxr-xr-xexamples/python_scripting.py2
4 files changed, 12 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ffac39bf..88898f8d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -274,7 +274,7 @@ where `4` should be replaced by the number of parallel threads you wish to run f
Code coverage can be measured as follows:
```shell
-py.test --cov=cmd2 --cov-report term-missing --cov-report=html
+py.test -nauto --cov=cmd2 --cov-report=term-missing --cov-report=html
```
Then use your web browser of choice to look at the results which are in `<cmd2>/htmlcov/index.html`.
@@ -390,6 +390,14 @@ how to do it.
6. Indicate what local testing you have done (e.g. what OS and version(s) of Python did you run the
unit test suite with)
+
+7. Creating the PR causes our continuous integration (CI) systems to automatically run all of the
+ unit tests on all supported OSes and all supported versions of Python. You should watch your PR
+ to make sure that all unit tests pass on Both TravisCI (Linux) and AppVeyor (Windows).
+
+8. If any unit tests fail, you should look at the details and fix the failures. You can then push
+ the fix to the same branch in your fork and the PR will automatically get updated and the CI system
+ will automatically run all of the unit tests again.
### How We Review and Merge Pull Requests
diff --git a/README.md b/README.md
index 805ce5d6..b499eb41 100755
--- a/README.md
+++ b/README.md
@@ -13,6 +13,8 @@ applications. It provides a simple API which is an extension of Python's built-
of cmd to make your life easier and eliminates much of the boilerplate code which would be necessary
when using cmd.
+[![Screenshot](cmd2.png)](https://github.com/python-cmd2/cmd2/blob/master/cmd2.png)
+
Main Features
-------------
diff --git a/cmd2.png b/cmd2.png
new file mode 100644
index 00000000..810f7c9e
--- /dev/null
+++ b/cmd2.png
Binary files differ
diff --git a/examples/python_scripting.py b/examples/python_scripting.py
index a0d36e36..ae04fda1 100755
--- a/examples/python_scripting.py
+++ b/examples/python_scripting.py
@@ -36,7 +36,7 @@ class CmdLineApp(Cmd):
def _set_prompt(self):
"""Set prompt so it displays the current working directory."""
self.cwd = os.getcwd()
- self.prompt = '{!r} $ '.format(self.cwd)
+ self.prompt = self.colorize('{!r} $ '.format(self.cwd), 'cyan')
def postcmd(self, stop, line):
"""Hook method executed just after a command dispatch is finished.