Mithil467/mitype

View on GitHub
docs/source/usage.rst

Summary

Maintainability
Test Coverage
Usage
#####

Once installed, you can run it simply as:

.. code-block::

   mitype

You can also customize each run by specifying the following options as:

* | ``-f FILENAME, --file FILENAME``
  | Uses contents of file as sample text.
* | ``-d N, --difficulty N``
  | N can be in range [1, 5] with 1 being the easiest. This decides the length of the text.
* | ``-i ID, --id ID``
  | ID can be in range [1, 6000].

| Mitype keeps record of each test in `.mitype_history.csv`.
| ``-H N, --history N`` displays last N records.
| N is optional, in the absence of which all records are printed.

You can quit mitype anytime by pressing the `ESC` key or `CTRL-C`.