diff options
Diffstat (limited to 'libraries/progressbar/README')
| -rw-r--r-- | libraries/progressbar/README | 14 |
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. |