mirror of https://github.com/tqdm/tqdm.git
Update README.md and CONTRIBUTE
Signed-off-by: Stephen L. <lrq3000@gmail.com>
This commit is contained in:
parent
0a063c7024
commit
5e57e55f08
|
@ -34,7 +34,7 @@ unit tests pass. This will ensure that your changes did not introduce
|
||||||
any regression in the features that already working.
|
any regression in the features that already working.
|
||||||
|
|
||||||
To run the test, cd to the root of the tqdm folder (in the same folder
|
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
|
make test
|
||||||
|
|
12
README.md
12
README.md
|
@ -25,10 +25,10 @@ version is much more visually appealing.
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# newer, faster, prettier, stable version
|
# Latest stable release on pypi
|
||||||
pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm
|
|
||||||
# or (old version on pypi)
|
|
||||||
pip install tqdm
|
pip install tqdm
|
||||||
|
# Latest development release on github
|
||||||
|
pip install -e git+https://github.com/tqdm/tqdm.git@master#egg=tqdm
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
@ -160,7 +160,7 @@ def my_hook(**kwargs):
|
||||||
t.close()
|
t.close()
|
||||||
return
|
return
|
||||||
t.total = tsize
|
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
|
last_b[0] = b
|
||||||
return inner
|
return inner
|
||||||
|
|
||||||
|
@ -190,6 +190,8 @@ $ make test
|
||||||
$ make coverage
|
$ make coverage
|
||||||
```
|
```
|
||||||
|
|
||||||
|
See also the CONTRIBUTE file for more information.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT LICENSE](LICENSE).
|
[MIT LICENSE](LICENSE).
|
||||||
|
@ -202,4 +204,4 @@ $ make coverage
|
||||||
- Mikhail Korobov (kmike)
|
- Mikhail Korobov (kmike)
|
||||||
- Hadrien Mary (hadim)
|
- Hadrien Mary (hadim)
|
||||||
- Casper da Costa-Luis (casperdcl)
|
- Casper da Costa-Luis (casperdcl)
|
||||||
- Stephen L (lrq3000)
|
- Stephen Larroque (lrq3000)
|
||||||
|
|
Loading…
Reference in New Issue