Skip to content

Commit 5b48354

Browse files
committed
doc: Include a download link near the top of README.md
Signed-off-by: Michael Brown <[email protected]>
1 parent 442cd7b commit 5b48354

File tree

5 files changed

+22
-3
lines changed

5 files changed

+22
-3
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@ CX: Privacy-compatible distributed contact tracing
33

44
![Build documentation](https://github.com/ipxe/cx/workflows/Build%20documentation/badge.svg)
55

6+
Download the full [architecture
7+
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
8+
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
9+
10+
Overview
11+
--------
12+
613
CX is an architecture for privacy-compatible distributed contact
714
tracing, designed for use in pandemics such as Covid-19. It operates
815
using a model of proximity-based contact detection over one or more
@@ -225,4 +232,5 @@ Details
225232
-------
226233

227234
For more information, see the [architecture
228-
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf).
235+
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
236+
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)

pdf.png

714 Bytes
Loading

spec/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,13 @@ cx-intro.md : cx.md Makefile
5454
../%.png : %.svg Makefile
5555
rsvg-convert -f png -d 150 -o $@ $<
5656

57+
../pdf.png : clipart/pdf.svg Makefile
58+
rsvg-convert -f png -h 32 -o $@ $<
59+
5760
../README.md : README-header.md.part cx-intro.md README-footer.md.part \
5861
../broadcasting.png ../observing.png ../diagnosis.png \
5962
../publication.png ../international.png ../cooperation.png \
60-
Makefile
63+
../pdf.png Makefile
6164
cat README-header.md.part cx-intro.md README-footer.md.part > $@
6265

6366
readme : ../README.md Makefile

spec/README-footer.md.part

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ Details
22
-------
33

44
For more information, see the [architecture
5-
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf).
5+
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
6+
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)

spec/README-header.md.part

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,10 @@ CX: Privacy-compatible distributed contact tracing
22
==================================================
33

44
![Build documentation](https://github.com/ipxe/cx/workflows/Build%20documentation/badge.svg)
5+
6+
Download the full [architecture
7+
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
8+
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
9+
10+
Overview
11+
--------

0 commit comments

Comments
 (0)