From 5910fe139b53478178a8f32043090f45a59c0a40 Mon Sep 17 00:00:00 2001 From: Stephen L Date: Sun, 11 Oct 2015 19:18:30 +0200 Subject: [PATCH] Extracted RELEASE info from CONTRIBUTE --- CONTRIBUTE | 7 ++----- README.rst | 20 +++++++++++++++++--- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTE b/CONTRIBUTE index 503166e4..3348476c 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -30,11 +30,8 @@ TESTING To test functionality on your machine (such as before submitting a Pull Request), there are a number of unit tests. -To run the tests, - -- install `tox` -- `cd` to the root of the `tqdm` directory (in the same folder as this file) -- run the following commands: +To run the test, cd to the root of the tqdm folder (in the same folder +as this file), and then type the following (you need to install `tox`): ``` make test diff --git a/README.rst b/README.rst index b310b203..258a8ab3 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,12 @@ tqdm (read taqadum, تقدّم) means "progress" in arabic. Instantly make your loops show a progress meter - just wrap any iterable with "tqdm(iterable)", and you're done! +.. code:: python + + from tqdm import tqdm + for i in tqdm(range(16)): + ... + Here's what the output looks like: 76%\|████████████████████\ ````` ````` \| 7641/10000 [00:34<00:10, @@ -29,11 +35,19 @@ version is much more visually appealing. Installation ------------ +Latest pypi stable release +~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. code:: sh - # Latest stable release on pypi pip install tqdm - # Latest development release on github + +Latest development release on github +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Pull and install in the current directory: + +:: pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm Documentation @@ -201,7 +215,7 @@ with the following command: $ make test $ make coverage -See also the CONTRIBUTE file for more information. +See the `CONTRIBUTE `__ file for more information. License -------