aboutsummaryrefslogtreecommitdiff
path: root/libraries/progressbar/README
diff options
context:
space:
mode:
authorLionel Young <redtricycle@gmail.com>2010-12-19 00:52:35 -0200
committerRobby Workman <rworkman@slackbuilds.org>2010-12-20 22:44:02 -0600
commit3012dbb96324830d00814e3527b2b920afe3ab86 (patch)
treef400295cd96a49f647cff0c4be74c4d672e674a8 /libraries/progressbar/README
parenta45025633d3b17c788662398e208e78d5b726ecd (diff)
libraries/progressbar: Added (Text progressbar library for python)
Signed-off-by: Niels Horn <niels.horn@slackbuilds.org>
Diffstat (limited to 'libraries/progressbar/README')
-rw-r--r--libraries/progressbar/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/libraries/progressbar/README b/libraries/progressbar/README
new file mode 100644
index 0000000000000..0f929b1e91a3d
--- /dev/null
+++ b/libraries/progressbar/README
@@ -0,0 +1,14 @@
+This library provides a text mode progressbar. This is typically used
+to display the progress of a long running operation, providing a visual
+clue that processing is underway.
+
+The ProgressBar class manages the progress, and the format of the line
+is given by a number of widgets. A widget is an object that may display
+diferently depending on the state of the progress. There are three types
+of widget: - a string, which always shows itself; - a ProgressBarWidget,
+which may return a diferent value every time it's update method is called;
+and - a ProgressBarWidgetHFill, which is like ProgressBarWidget, except
+it expands to fill the remaining width of the line.
+
+The progressbar module is very easy to use, yet very powerful. And
+automatically supports features like auto-resizing when available.