From 5e57e55f085e4f9b4ffa11bfa3a93cd8d3f2d32a Mon Sep 17 00:00:00 2001 From: Stephen L Date: Sun, 11 Oct 2015 16:49:12 +0200 Subject: [PATCH] Update README.md and CONTRIBUTE Signed-off-by: Stephen L. --- CONTRIBUTE | 2 +- README.md | 12 +++++++----- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTE b/CONTRIBUTE index 273d5458..a2b9e7ab 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -34,7 +34,7 @@ unit tests pass. This will ensure that your changes did not introduce any regression in the features that already working. To run the test, cd to the root of the tqdm folder (in the same folder -as this file), and then type the following: +as this file), and then type the following (you need to install `tox`): ``` make test diff --git a/README.md b/README.md index 4c28de31..d3c04f0e 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ version is much more visually appealing. ## Installation ```sh -# newer, faster, prettier, stable version -pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm -# or (old version on pypi) +# Latest stable release on pypi pip install tqdm +# Latest development release on github +pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm ``` ## Documentation @@ -160,7 +160,7 @@ def my_hook(**kwargs): t.close() return t.total = tsize - t.update((b - last_b[0]) * bsize) + t.update((b - last_b[0]) * bsize) # manually update the progressbar last_b[0] = b return inner @@ -190,6 +190,8 @@ $ make test $ make coverage ``` +See also the CONTRIBUTE file for more information. + ## License [MIT LICENSE](LICENSE). @@ -202,4 +204,4 @@ $ make coverage - Mikhail Korobov (kmike) - Hadrien Mary (hadim) - Casper da Costa-Luis (casperdcl) -- Stephen L (lrq3000) +- Stephen Larroque (lrq3000)