Skip to content

Commit

Permalink
doc: Include a download link near the top of README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Brown <[email protected]>
  • Loading branch information
mcb30 committed Apr 17, 2020
1 parent 442cd7b commit 5b48354
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 3 deletions.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ CX: Privacy-compatible distributed contact tracing

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

Download the full [architecture
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)

Overview
--------

CX is an architecture for privacy-compatible distributed contact
tracing, designed for use in pandemics such as Covid-19. It operates
using a model of proximity-based contact detection over one or more
Expand Down Expand Up @@ -225,4 +232,5 @@ Details
-------

For more information, see the [architecture
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf).
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
Binary file added pdf.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion spec/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,13 @@ cx-intro.md : cx.md Makefile
../%.png : %.svg Makefile
rsvg-convert -f png -d 150 -o $@ $<

../pdf.png : clipart/pdf.svg Makefile
rsvg-convert -f png -h 32 -o $@ $<

../README.md : README-header.md.part cx-intro.md README-footer.md.part \
../broadcasting.png ../observing.png ../diagnosis.png \
../publication.png ../international.png ../cooperation.png \
Makefile
../pdf.png Makefile
cat README-header.md.part cx-intro.md README-footer.md.part > $@

readme : ../README.md Makefile
Expand Down
3 changes: 2 additions & 1 deletion spec/README-footer.md.part
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ Details
-------

For more information, see the [architecture
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf).
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
7 changes: 7 additions & 0 deletions spec/README-header.md.part
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,10 @@ CX: Privacy-compatible distributed contact tracing
==================================================

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

Download the full [architecture
specification](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)
[![PDF](pdf.png)](https://github.com/ipxe/cx/releases/latest/download/cx.pdf)

Overview
--------

0 comments on commit 5b48354

Please sign in to comment.