Skip to content

Commit c53d715

Browse files
yurrriqyurrriq
committed
README.md: update known working versions
Close #11
1 parent 48c05d2 commit c53d715

File tree

2 files changed

+82
-164
lines changed

2 files changed

+82
-164
lines changed

‎README.md

Lines changed: 27 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -3,108 +3,45 @@
33
:book: [Download the PDF][PDF]
44

55

6-
## Usage
6+
## Building
77

88
To rebuild the PDF, ensure the [prerequisites][prereqs] are installed, then:
99

1010
```fish
11-
make
11+
make pdf
1212
```
1313

1414

15-
## Prerequisites
15+
### Prerequisites
1616

17-
- [Idris](http://www.idris-lang.org)
18-
- [Make](https://www.gnu.org/software/make/)
19-
- [Pandoc](http://pandoc.org)
20-
- [Python](https://www.python.org)
21-
- [Pygments](http://pygments.org)
22-
- [XeLaTeX](http://tug.org/xetex/)
23-
- [minted](http://www.ctan.org/pkg/minted)
17+
Others may work, but here are the versions I'm using.
2418

19+
| Dependency | Version |
20+
|------------------|----------------------------------------|
21+
| [(run)ghc][GHC] | 8.0.2 |
22+
| [Idris][] | 1.0 |
23+
| [Make][] | 4.2.1 |
24+
| [minted][] | 2.4.1 |
25+
| [Monoid][] | 0.61 |
26+
| [Pandoc][] | 1.19.2.1 |
27+
| [pandoc-types][] | 1.17.0.5 |
28+
| [Python][] | 3.6.1 |
29+
| [Pygments][] | 2.2.0 |
30+
| [XeLaTeX][] | 3.14159265-2.6-0.99998 (TeX Live 2017) |
2531

26-
Others may work, but here are the versions I'm using:
27-
28-
```fish
29-
$ idris --version
30-
0.12
31-
```
32-
33-
<details>
34-
<summary>`$ make --version`</summary>
35-
```fish
36-
GNU Make 3.81
37-
Copyright (C) 2006 Free Software Foundation, Inc.
38-
This is free software; see the source for copying conditions.
39-
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
40-
PARTICULAR PURPOSE.
41-
42-
This program built for i386-apple-darwin11.3.0
43-
```
44-
</details>
45-
46-
<details>
47-
<summary>`$ pandoc --version`</summary>
48-
```fish
49-
pandoc 1.17.1
50-
Compiled with texmath 0.8.6.3, highlighting-kate 0.6.2.
51-
Syntax highlighting is supported for the following languages:
52-
abc, actionscript, ada, agda, apache, asn1, asp, awk, bash, bibtex, boo, c,
53-
changelog, clojure, cmake, coffee, coldfusion, commonlisp, cpp, cs, css,
54-
curry, d, diff, djangotemplate, dockerfile, dot, doxygen, doxygenlua, dtd,
55-
eiffel, elixir, email, erlang, fasm, fortran, fsharp, gcc, glsl,
56-
gnuassembler, go, hamlet, haskell, haxe, html, idris, ini, isocpp, java,
57-
javadoc, javascript, json, jsp, julia, kotlin, latex, lex, lilypond,
58-
literatecurry, literatehaskell, llvm, lua, m4, makefile, mandoc, markdown,
59-
mathematica, matlab, maxima, mediawiki, metafont, mips, modelines, modula2,
60-
modula3, monobasic, nasm, noweb, objectivec, objectivecpp, ocaml, octave,
61-
opencl, pascal, perl, php, pike, postscript, prolog, pure, python, r,
62-
relaxng, relaxngcompact, rest, rhtml, roff, ruby, rust, scala, scheme, sci,
63-
sed, sgml, sql, sqlmysql, sqlpostgresql, tcl, tcsh, texinfo, verilog, vhdl,
64-
xml, xorg, xslt, xul, yacc, yaml, zsh
65-
Default user data directory: /Users/mohacker/.pandoc
66-
Copyright (C) 2006-2016 John MacFarlane
67-
Web: http://pandoc.org
68-
This is free software; see the source for copying conditions.
69-
There is no warranty, not even for merchantability or fitness
70-
for a particular purpose.
71-
```
72-
</details>
73-
74-
```fish
75-
$ python --version
76-
Python 2.7.10
77-
```
78-
79-
```fish
80-
$ pygmentize -V
81-
Pygments version 2.1.3, (c) 2006-2015 by Georg Brandl.
82-
```
83-
84-
<details>
85-
<summary>`$ xelatex --version`</summary>
86-
```fish
87-
XeTeX 3.14159265-2.6-0.99996 (TeX Live 2016)
88-
kpathsea version 6.2.2
89-
Copyright 2016 SIL International, Jonathan Kew and Khaled Hosny.
90-
There is NO warranty. Redistribution of this software is
91-
covered by the terms of both the XeTeX copyright and
92-
the Lesser GNU General Public License.
93-
For more information about these matters, see the file
94-
named COPYING and the XeTeX source.
95-
Primary author of XeTeX: Jonathan Kew.
96-
Compiled with ICU version 57.1; using 57.1
97-
Compiled with zlib version 1.2.8; using 1.2.8
98-
Compiled with FreeType2 version 2.6.3; using 2.6.3
99-
Compiled with Graphite2 version 1.3.8; using 1.3.8
100-
Compiled with HarfBuzz version 1.2.6; using 1.2.6
101-
Compiled with libpng version 1.6.21; using 1.6.21
102-
Compiled with poppler version 0.42.0
103-
Using Mac OS X Core Text and Cocoa frameworks
104-
```
105-
</details>
10632

33+
<!-- Named Links -->
10734

10835
[SF]: http://www.cis.upenn.edu/%7Ebcpierce/sf/current/index.html
10936
[PDF]: https://idris-hackers.github.io/software-foundations/pdf/sf-idris-2016.pdf
11037
[prereqs]: #prerequisites
38+
[GHC]: https://www.haskell.org/ghc/
39+
[Idris]: https://www.idris-lang.org
40+
[Make]: https://www.gnu.org/software/make/
41+
[minted]: http://www.ctan.org/pkg/minted
42+
[Monoid]: http://larsenwork.com/monoid/
43+
[Pandoc]: http://pandoc.org
44+
[pandoc-types]: https://github.com/jgm/pandoc-types
45+
[Python]: https://www.python.org
46+
[Pygments]: http://pygments.org
47+
[XeLaTeX]: http://tug.org/xetex/

‎docs/index.html

Lines changed: 55 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -10,80 +10,61 @@
1010
<body>
1111
<h1 id="software-foundationssf-in-idris"><em><a href="http://www.cis.upenn.edu/%7Ebcpierce/sf/current/index.html">Software Foundations</a> in Idris</em></h1>
1212
<p>📖 <a href="https://idris-hackers.github.io/software-foundations/pdf/sf-idris-2016.pdf">Download the PDF</a></p>
13-
<h2 id="usage">Usage</h2>
13+
<h2 id="building">Building</h2>
1414
<p>To rebuild the PDF, ensure the <a href="#prerequisites">prerequisites</a> are installed, then:</p>
15-
<pre class="fish"><code>make</code></pre>
16-
<h2 id="prerequisites">Prerequisites</h2>
17-
<ul>
18-
<li><a href="http://www.idris-lang.org">Idris</a></li>
19-
<li><a href="https://www.gnu.org/software/make/">Make</a></li>
20-
<li><a href="http://pandoc.org">Pandoc</a></li>
21-
<li><a href="https://www.python.org">Python</a></li>
22-
<li><a href="http://pygments.org">Pygments</a></li>
23-
<li><a href="http://tug.org/xetex/">XeLaTeX</a></li>
24-
<li><a href="http://www.ctan.org/pkg/minted">minted</a></li>
25-
</ul>
26-
<p>Others may work, but here are the versions I'm using:</p>
27-
<pre class="fish"><code>$ idris --version
28-
0.12</code></pre>
29-
<p><details><br />
30-
<summary><code>$ make --version</code></summary></p>
31-
<pre class="fish"><code>GNU Make 3.81
32-
Copyright (C) 2006 Free Software Foundation, Inc.
33-
This is free software; see the source for copying conditions.
34-
There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
35-
PARTICULAR PURPOSE.
36-
37-
This program built for i386-apple-darwin11.3.0</code></pre>
38-
<p></details></p>
39-
<p><details><br />
40-
<summary><code>$ pandoc --version</code></summary></p>
41-
<pre class="fish"><code>pandoc 1.17.1
42-
Compiled with texmath 0.8.6.3, highlighting-kate 0.6.2.
43-
Syntax highlighting is supported for the following languages:
44-
abc, actionscript, ada, agda, apache, asn1, asp, awk, bash, bibtex, boo, c,
45-
changelog, clojure, cmake, coffee, coldfusion, commonlisp, cpp, cs, css,
46-
curry, d, diff, djangotemplate, dockerfile, dot, doxygen, doxygenlua, dtd,
47-
eiffel, elixir, email, erlang, fasm, fortran, fsharp, gcc, glsl,
48-
gnuassembler, go, hamlet, haskell, haxe, html, idris, ini, isocpp, java,
49-
javadoc, javascript, json, jsp, julia, kotlin, latex, lex, lilypond,
50-
literatecurry, literatehaskell, llvm, lua, m4, makefile, mandoc, markdown,
51-
mathematica, matlab, maxima, mediawiki, metafont, mips, modelines, modula2,
52-
modula3, monobasic, nasm, noweb, objectivec, objectivecpp, ocaml, octave,
53-
opencl, pascal, perl, php, pike, postscript, prolog, pure, python, r,
54-
relaxng, relaxngcompact, rest, rhtml, roff, ruby, rust, scala, scheme, sci,
55-
sed, sgml, sql, sqlmysql, sqlpostgresql, tcl, tcsh, texinfo, verilog, vhdl,
56-
xml, xorg, xslt, xul, yacc, yaml, zsh
57-
Default user data directory: /Users/mohacker/.pandoc
58-
Copyright (C) 2006-2016 John MacFarlane
59-
Web: http://pandoc.org
60-
This is free software; see the source for copying conditions.
61-
There is no warranty, not even for merchantability or fitness
62-
for a particular purpose.</code></pre>
63-
<p></details></p>
64-
<pre class="fish"><code>$ python --version
65-
Python 2.7.10</code></pre>
66-
<pre class="fish"><code>$ pygmentize -V
67-
Pygments version 2.1.3, (c) 2006-2015 by Georg Brandl.</code></pre>
68-
<p><details><br />
69-
<summary><code>$ xelatex --version</code></summary></p>
70-
<pre class="fish"><code>XeTeX 3.14159265-2.6-0.99996 (TeX Live 2016)
71-
kpathsea version 6.2.2
72-
Copyright 2016 SIL International, Jonathan Kew and Khaled Hosny.
73-
There is NO warranty. Redistribution of this software is
74-
covered by the terms of both the XeTeX copyright and
75-
the Lesser GNU General Public License.
76-
For more information about these matters, see the file
77-
named COPYING and the XeTeX source.
78-
Primary author of XeTeX: Jonathan Kew.
79-
Compiled with ICU version 57.1; using 57.1
80-
Compiled with zlib version 1.2.8; using 1.2.8
81-
Compiled with FreeType2 version 2.6.3; using 2.6.3
82-
Compiled with Graphite2 version 1.3.8; using 1.3.8
83-
Compiled with HarfBuzz version 1.2.6; using 1.2.6
84-
Compiled with libpng version 1.6.21; using 1.6.21
85-
Compiled with poppler version 0.42.0
86-
Using Mac OS X Core Text and Cocoa frameworks</code></pre>
87-
<p></details></p>
15+
<pre class="fish"><code>make pdf</code></pre>
16+
<h3 id="prerequisites">Prerequisites</h3>
17+
<p>Others may work, but here are the versions I'm using.</p>
18+
<table>
19+
<thead>
20+
<tr class="header">
21+
<th>Dependency</th>
22+
<th>Version</th>
23+
</tr>
24+
</thead>
25+
<tbody>
26+
<tr class="odd">
27+
<td><a href="https://www.haskell.org/ghc/">(run)ghc</a></td>
28+
<td>8.0.2</td>
29+
</tr>
30+
<tr class="even">
31+
<td><a href="https://www.idris-lang.org">Idris</a></td>
32+
<td>1.0</td>
33+
</tr>
34+
<tr class="odd">
35+
<td><a href="https://www.gnu.org/software/make/">Make</a></td>
36+
<td>4.2.1</td>
37+
</tr>
38+
<tr class="even">
39+
<td><a href="http://www.ctan.org/pkg/minted">minted</a></td>
40+
<td>2.4.1</td>
41+
</tr>
42+
<tr class="odd">
43+
<td><a href="http://larsenwork.com/monoid/">Monoid</a></td>
44+
<td>0.61</td>
45+
</tr>
46+
<tr class="even">
47+
<td><a href="http://pandoc.org">Pandoc</a></td>
48+
<td>1.19.2.1</td>
49+
</tr>
50+
<tr class="odd">
51+
<td><a href="https://github.com/jgm/pandoc-types">pandoc-types</a></td>
52+
<td>1.17.0.5</td>
53+
</tr>
54+
<tr class="even">
55+
<td><a href="https://www.python.org">Python</a></td>
56+
<td>3.6.1</td>
57+
</tr>
58+
<tr class="odd">
59+
<td><a href="http://pygments.org">Pygments</a></td>
60+
<td>2.2.0</td>
61+
</tr>
62+
<tr class="even">
63+
<td><a href="http://tug.org/xetex/">XeLaTeX</a></td>
64+
<td>3.14159265-2.6-0.99998 (TeX Live 2017)</td>
65+
</tr>
66+
</tbody>
67+
</table>
68+
<!-- Named Links -->
8869
</body>
8970
</html>

0 commit comments

Comments
 (0)