Skip to content

Commit 7004482

Browse files
committed
Add on-demand PDF file generation links
- Use @zbeekman's heroku instance of <https://github.com/benbalter/markdown-to-pdf> to generate PDFs of markdown documents hosted in the GitHub repo - Remove some shields.io badges that are not loading. This appears to be a shields.io bug.
1 parent fbc5b7b commit 7004482

File tree

7 files changed

+49
-7
lines changed

7 files changed

+49
-7
lines changed

AUTHORS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Contributors to OpenCoarrays
22
============================
33

4+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/AUTHORS.pdf)
5+
6+
Download this file as a PDF document
7+
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/AUTHORS.pdf).
8+
49
- Alessandro Fanfarillo <[email protected]>
510
- Damian Rouson <[email protected]>
611
- Izaak Beekman <http://izaakbeekman.com>
@@ -12,3 +17,6 @@ Contributors to OpenCoarrays
1217
[@naveen-rn?]:#
1318
[@raul-nasner?]:#
1419
[Others:]:#
20+
21+
[Links]:#
22+
[pdf img]: https://img.shields.io/badge/PDF-AUTHORS.md-6C2DC7.svg?style=flat-square "Download as PDF"

CAF_ABI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
OpenCoarrays Application Binary Interface (ABI)
66
===============================================
77

8+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/CAF_ABI.pdf)
9+
10+
Download this file as a PDF document
11+
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/CAF_ABI.pdf).
12+
813
* [To Do](#to-do)
914
* [Implementation status](#implementation-status)
1015
* [Definitions and types](#definitions-and-types)
@@ -563,3 +568,4 @@ __TODO__:
563568
[Implementation status]: #implementation-status
564569
[Definitions and types]: #definitions-and-types
565570
[Provided functions]: #provided-functions
571+
[pdf img]: https://img.shields.io/badge/PDF-CAF_ABI.md-6C2DC7.svg?style=flat-square "Download as PDF"

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
Contributing to OpenCoarrays
44
============================
55

6+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.pdf)
7+
8+
Download this file as a PDF document
9+
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.pdf).
10+
611
- [Reporting Defects](#reporting-defects)
712
- [Requesting Enhancements](#requesting-enhancements)
813
- [Helping Out](#helping-out)
@@ -106,3 +111,4 @@ This is the development branch, akin to GCC's `trunk`. Both of `devel` and `mast
106111
[mailing list]: https://groups.google.com/forum/#!forum/opencoarrays
107112
[using OpenCoarrays]: ./GETTING_STARTED.md
108113
[new issue]: https://github.com/sourceryinstitute/opencoarrays/issues/new
114+
[pdf img]: https://img.shields.io/badge/PDF-CONTRIBUTING.md-6C2DC7.svg?style=flat-square "Download as PDF"

GETTING_STARTED.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
Getting Started
88
===============
99

10+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/GETTING_STARTED.pdf)
11+
12+
Download this file as a PDF document
13+
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/GETTING_STARTED.pdf).
14+
1015
* [The caf compiler wrapper]
1116
* [A sample basic workflow]
1217
* [An advanced workflow]
@@ -124,3 +129,4 @@ mpirun -np <number-of-images> ./tally
124129
[TS 18508]: http://isotc.iso.org/livelink/livelink?func=ll&objId=17181227&objAction=Open
125130
[The caf compiler wrapper]: #the-caf-compiler-wrapper
126131
[The cafrun program launcher]: #the-cafrun-program-launcher
132+
[pdf img]: https://img.shields.io/badge/PDF-GETTING_STARTED.md-6C2DC7.svg?style=flat-square "Download as PDF"

INSTALL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
Installing OpenCoarrays
88
=======================
99

10+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/INSTALL.pdf)
11+
12+
Download this file as a PDF document
13+
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/INSTALL.pdf).
14+
1015
* [End-User Installation]
1116
* [Installation Script]
1217
* [OS X]
@@ -258,3 +263,4 @@ where the second line builds the flex package that is required for building gcc
258263
[Arch Linux]: https://www.archlinux.org
259264
[aur package]: https://aur.archlinux.org/packages/opencoarrays/
260265
[Releases]: https://github.com/sourceryinstitute/opencoarrays/releases
266+
[pdf img]: https://img.shields.io/badge/PDF-INSTALL.md-6C2DC7.svg?style=flat-square "Download as PDF"

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,13 @@ OpenCoarrays
88
============
99

1010
[![CI Build Status][build img]](https://travis-ci.org/sourceryinstitute/opencoarrays)
11-
[![GitHub release][release img]](https://github.com/sourceryinstitute/opencoarrays/releases/latest)
12-
[![GitHub license][license img]](COPYRIGHT-BSD3)
11+
[![GitHub license][license img]](./COPYRIGHT-BSD3)
12+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/README.pdf)
13+
<!-- [![GitHub release][release img]](https://github.com/sourceryinstitute/opencoarrays/releases/latest) -->
1314
<!-- [![Release Downloads][download img]](https://github.com/sourceryinstitute/opencoarrays/releases) -->
1415

16+
Download this file as a PDF document [here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/README.pdf).
17+
1518
* [Overview](#overview)
1619
* [Downloads](#downloads)
1720
* [Compatibility](#compatibility)
@@ -35,7 +38,7 @@ OpenCoarrays enables CAF application developers to express parallel algorithms w
3538

3639
Downloads
3740
---------
38-
[![Release Downloads][download img]](https://github.com/sourceryinstitute/opencoarrays/releases/latest)
41+
<!--[![Release Downloads][download img]](https://github.com/sourceryinstitute/opencoarrays/releases/latest)-->
3942

4043
Please see our [Releases] page.
4144

@@ -125,8 +128,9 @@ We gratefully acknowledge support from the following institutions:
125128
[Issues]: https://github.com/sourceryinstitute/opencoarrays/issues
126129
[Releases]: https://github.com/sourceryinstitute/opencoarrays/releases
127130

128-
[build img]: https://img.shields.io/travis-ci/sourceryinstitute/opencoarrays/master.svg?style=flat-square "Travis-CI badge image source"
129-
[CI Master Branch]: https://travis-ci.org/sourceryinstitute/opencoarrays?branch=master "Travis-CI builds"
131+
[build img]: https://img.shields.io/travis-ci/sourceryinstitute/opencoarrays/master.svg?style=flat-square "View Travis-CI builds"
132+
[CI Master Branch]: https://travis-ci.org/sourceryinstitute/opencoarrays?branch=master "View Travis-CI builds"
130133
[download img]: https://img.shields.io/github/downloads/sourceryinstitute/opencoarrays/total.svg?style=flat-square "Download count image source"
131-
[license img]: https://img.shields.io/github/license/sourceryinstitute/opencoarrays.svg?style=flat-square "BSD-3 License badge"
132-
[release img]: https://img.shields.io/github/release/sourceryinstitute/opencoarrays.svg?style=flat-square "Latest release badge"
134+
[license img]: https://img.shields.io/badge/License-BSD--3-blue.svg?style=flat-square "View BSD-3 License"
135+
[release img]: https://img.shields.io/github/release/sourceryinstitute/opencoarrays.svg?style=flat-square "View latest release"
136+
[pdf img]: https://img.shields.io/badge/PDF-README.md-6C2DC7.svg?style=flat-square "Download as PDF"

STATUS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
OpenCoarrays Status
88
===================
99

10+
[![Download as PDF][pdf img]](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/STATUS.pdf)
11+
12+
Download this file as a PDF document
13+
[here](http://md2pdf.herokuapp.com/sourceryinstitute/opencoarrays/blob/master/STATUS.pdf).
14+
1015
* [Feature Coverage](#feature-coverage)
1116
* [Compiler Status](#compiler-status)
1217
* [OpenCoarrays-Aware (OCA) Coarray Fortran (CAF) Compilers]
@@ -198,3 +203,4 @@ To-Do List
198203
[OpenCoarrays Google Group]: https://groups.google.com/forum/#!forum/opencoarrays
199204
[Sourcery Store]: http://www.sourceryinstitute.org/store
200205
[Issues]: https://github.com/sourceryinstitute/opencoarrays/issues
206+
[pdf img]: https://img.shields.io/badge/PDF-STATUS.md-6C2DC7.svg?style=flat-square "Download as PDF"

0 commit comments

Comments
 (0)