Skip to content

Commit 7f2fd23

Browse files
committed
Badge cleanup; more directions on running demo tracker
Cleaned up badges. Also added a couple of commented out possibly useful badges: * commits different between named tag/release and head * last tagged revision (use for alpha/beta releases) Also expanded to 4 explicit command for getting and running Roundup in demo mode. Emphasized that demo mode does not require installation.
1 parent a22df61 commit 7f2fd23

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

website/www/index.txt

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,39 +21,50 @@ Roundup Issue Tracker
2121
<div class="release_info note">
2222
<!-- package version/pypi download -->
2323
<a
24-
href="https://pypi.org/project/roundup/#files">
24+
href="https://pypi.org/project/roundup/#files">
2525
<span style="padding-inline-end: 1.75ch">Download:</span>
2626
<img style="vertical-align: text-top"
27-
src="https://img.shields.io/pypi/v/roundup?color=blue&label=Current%20Version&cacheSeconds=86400"
28-
alt="Display current version of Roundup on PyPI."
29-
height="18" width="127">
27+
src="https://img.shields.io/pypi/v/roundup?color=blue&label=Current%20Version&cacheSeconds=86400"
28+
alt="Display current version of Roundup on PyPI."
29+
height="18" width="127">
3030
</a>
3131

3232
<!-- supported python versions: <img src="https://shields.io/pypi/pyversions/roundup"> -->
3333
<!-- license: <img src="https://img.shields.io/pypi/l/roundup"> -->
3434
<!-- changes since 2.2.0 <img src="https://img.shields.io/github/commits-since/roundup-tracker/roundup/2.2.0/master?sort=semver"> -->
3535
<!-- status beta, stable, mature.... <img src="https://img.shields.io/pypi/status/roundup"> -->
3636
<!-- mozilla observatory <img src="https://img.shields.io/mozilla-observatory/grade/www.roundup-tracker.org?publish"> -->
37+
<!-- commits from last named release: <img alt="GitHub commits difference between two branches/tags/commits" src="https://img.shields.io/github/commits-difference/roundup-tracker/roundup?base=2.2.0&head=master">a -->
38+
<!-- newest tag by date - use for alpha/beta release notifications?
39+
<img alt="GitHub tag (latest by date)" src="https://img.shields.io/github/v/tag/roundup-tracker/roundup"> -->
3740

3841
<!-- downloads/month -->
39-
<a style="display:block; margin-block-start: 1em;"
40-
href="https://pypistats.org/packages/roundup">
42+
<a style="display:block; margin-block-start: 0.5em;"
43+
href="https://pypistats.org/packages/roundup">
4144
<span style="padding-inline-start: 10.75ch"></span>
4245
<img
43-
src="https://img.shields.io/badge/dynamic/json?color=blue&label=downloads%2Fmonth&cacheSeconds=86400&query=data.last_month&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Froundup%2Frecent"
44-
alt="Badge displaying downloads per month."
45-
height="18" width="127">
46+
src="https://img.shields.io/badge/dynamic/json?color=blue&label=Downloads%2FMonth&cacheSeconds=86400&query=data.last_month&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Froundup%2Frecent"
47+
alt="Badge displaying number of downloads per month."
48+
height="18" width="127">
49+
</a>
50+
<a style="display:block; margin-block-start: 0.5em;"
51+
href="https://hub.docker.com/r/rounduptracker/roundup">
52+
<span style="padding-inline-start: 10.75ch"></span>
53+
<img
54+
src="https://img.shields.io/docker/image-size/rounduptracker/roundup?label=Docker%20Size"
55+
alt="Graphic displaying size of newest docker image on hub.docker.com."
56+
height="18" width="127">
4657
</a>
4758

4859
<!-- build status -->
4960
<a
50-
style="display:block; margin-block-start: 1em;"
51-
href="https://github.com/roundup-tracker/roundup/actions?query=workflow%3Aroundup-ci++">
61+
style="display:block; margin-block-start: 1em;"
62+
href="https://github.com/roundup-tracker/roundup/actions?query=workflow%3Aroundup-ci++">
5263
<span>Build Status:</span>
5364
<img
54-
src="https://img.shields.io/github/workflow/status/roundup-tracker/roundup/roundup-ci?label=roundup-ci&logo=github"
55-
alt="Current build status on GitHub."
56-
height="18" width="127">
65+
src="https://github.com/roundup-tracker/roundup/actions/workflows/ci-test.yml/badge.svg"
66+
alt="Status of primary regression test job on github."
67+
height="18" width="127"><br>
5768
</a>
5869
</div>
5970

@@ -121,10 +132,20 @@ has been deployed for:
121132

122133
...and so on. It's been designed with :doc:`flexibility
123134
<docs/customizing>` in mind - it's not just another bug
124-
tracker. Roundup ships with a *demo tracker* to play with - after
125-
you've unpacked the source, just run "python demo.py" and load up the
135+
tracker. Roundup ships with a **demo tracker** to play with - you don't
136+
need to install Roundup. After
137+
you've unpacked the source, just run "``python demo.py``" and load up the
126138
URL it prints out!
127139

140+
To create a source directory and run the demo follow these simple
141+
steps (change the ``-2.2.0`` version identifier to match your downloaded
142+
file).
143+
144+
1. ``python -m pip download roundup``
145+
2. ``python -c 'import tarfile, sys; tarfile.open(sys.argv[1]).extractall();' roundup-2.2.0.tar.gz``
146+
3. ``cd roundup-2.2.0``
147+
4. ``python demo.py``
148+
128149
Roundup was originally released as version 0.1.1 in late August, 2001.
129150
The first `change note`_ written said:
130151

0 commit comments

Comments
 (0)