Skip to content

Commit

Permalink
Updated the readme files to reflect our increasing focus on speed and…
Browse files Browse the repository at this point in the history
… multi-process.
  • Loading branch information
CleanCut committed Jun 23, 2015
1 parent d642fc8 commit b4f2b89
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 14 deletions.
13 changes: 6 additions & 7 deletions README-pypi.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
Green
=====

Green is a colorful, clean, fast and powerful test runner for Python unit
tests.

Green is a clean, colorful, fast, multi-process test runner for Python.

Documentation
-------------
Expand All @@ -16,21 +14,22 @@ project.
Features
--------

- **Colorful** - Terminal output makes good use of color when the terminal supports it.
- **Clean** - Low redundancy in output. Result stats for each test is lined up in a vertical column.
- **Fast** - Can run tests in independent processes.
- **Colorful** - Terminal output makes good use of color when the terminal supports it.
- **Fast** - Can run tests in independent processes. (Only 1 by default for compatibility, try "-s 0" for best results)
- **Powerful** - Multi-target + auto-discovery.
- **Traditional** - Use the normal ``unittest`` classes and methods for your unit tests.
- **Descriptive** - Four verbosity levels, from just dots to full docstring output.
- **Convenient** - Bash-completion and ZSH-completion of options and test targets.
- **Thorough** - Built-in, optional integration with `coverage`_
- **Modern** - Supports Python 2.7, 3.3, 3.4, and `PyPy`_
- **Portable** - Completely supports OS X, Linux, and BSDs (and maybe Windows).
- **Modern** - Supports Python 2.7, 3.4+, `PyPy`_ and `PyPy3`_
- **Portable** - Completely supports OS X, Linux, and BSDs (and Windows most of the time).
- **Living** - This project grows and changes. See the `changelog`_


.. _GitHub page for Green: https://github.com/CleanCut/green#green
.. _tutorial on how to correctly layout unit tests: https://github.com/CleanCut/green#unit-test-structure-tutorial
.. _coverage: http://nedbatchelder.com/code/coverage/
.. _PyPy: http://pypy.org
.. _PyPy3: http://pypy.org
.. _changelog: https://github.com/CleanCut/green/blob/master/CHANGELOG.md
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
Green
Green: A clean, colorful, fast, multi-process test runner.
=====

[![Version](https://img.shields.io/pypi/v/green.svg?style=flat)](https://pypi.python.org/pypi/green)
[![Posix Build Status](https://img.shields.io/travis/CleanCut/green.svg?style=flat)](https://travis-ci.org/CleanCut/green)
[![Windows Build Status](http://img.shields.io/appveyor/ci/CleanCut/green.svg?style=flat)](https://ci.appveyor.com/project/CleanCut/green)
[![Coverage Status](https://img.shields.io/coveralls/CleanCut/green.svg?style=flat)](https://coveralls.io/r/CleanCut/green?branch=master)

Green is a **clean, colorful test runner** for Python unit tests.

#### Table of Contents

1. [Features](https://github.com/CleanCut/green#features)
Expand All @@ -29,17 +27,17 @@ Green is a **clean, colorful test runner** for Python unit tests.
Features
--------

- **Colorful** - Terminal output makes good use of color when the terminal supports it.
- **Clean** - Low redundancy in output. Result statistics for each test is vertically aligned.
- **Fast** - Tests can run in independent processes.
- **Colorful** - Terminal output makes good use of color when the terminal supports it.
- **Fast** - Tests run in independent processes. (Only 1 by default for compatibility, try `-s 0` for best results)
- **Powerful** - Multi-target + auto-discovery.
- **Traditional** - Use the normal `unittest` classes and methods for your unit tests.
- **Descriptive** - Four verbosity levels, from just dots to full docstring output.
- **Convenient** - Bash-completion and ZSH-completion of options and test targets.
- **Thorough** - Built-in, optional integration with
[coverage](http://nedbatchelder.com/code/coverage/).
- **Modern** - Supports Python 2.7, 3.4+, and [PyPy](http://pypy.org).
- **Portable** - Completely supports OS X, Linux, and BSDs (and maybe Windows).
- **Modern** - Supports Python 2.7, 3.4+, [PyPy](http://pypy.org), and [PyPy3](http://pypy.org).
- **Portable** - Completely supports OS X, Linux, and BSDs (and Windows most of the time).
- **Living** - This project grows and changes. See the
[changelog](https://github.com/CleanCut/green/blob/master/CHANGELOG.md)

Expand Down

0 comments on commit b4f2b89

Please sign in to comment.