Skip to content

Commit 57cb625

Browse files
committed
Mention 'humanfriendly --demo' in readme
1 parent 99402a6 commit 57cb625

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ text interfaces more user friendly. Some example features:
1919
- Prompting the user to select a choice from a list of options by typing the
2020
option's number or a unique substring of the option.
2121

22-
- Terminal interaction including text styling (ANSI escape sequences), user
22+
- Terminal interaction including text styling (`ANSI escape sequences`_), user
2323
friendly rendering of usage messages and querying the terminal for its
2424
size.
2525

@@ -49,6 +49,11 @@ It's very simple to start using the `humanfriendly` package::
4949
>>> print("You entered:", format_size(num_bytes, binary=True))
5050
You entered: 14.9 GiB
5151

52+
To get a demonstration of supported terminal text styles (based on
53+
`ANSI escape sequences`_) you can run the following command::
54+
55+
$ humanfriendly --demo
56+
5257
Command line
5358
------------
5459

@@ -153,6 +158,7 @@ This software is licensed under the `MIT license`_.
153158
.. _#4: https://github.com/xolox/python-humanfriendly/issues/4
154159
.. _#8: https://github.com/xolox/python-humanfriendly/pull/8
155160
.. _#9: https://github.com/xolox/python-humanfriendly/pull/9
161+
.. _ANSI escape sequences: https://en.wikipedia.org/wiki/ANSI_escape_code
156162
.. _changelog: https://humanfriendly.readthedocs.io/en/latest/changelog.html
157163
.. _colorama: https://pypi.org/project/colorama
158164
.. _format_size(): https://humanfriendly.readthedocs.io/en/latest/#humanfriendly.format_size

0 commit comments

Comments
 (0)