From 3005947e0bd19761442300d048137dba53401281 Mon Sep 17 00:00:00 2001
From: Ben Gamari <ben@smart-cactus.org>
Date: Fri, 1 Nov 2019 14:51:23 -0400
Subject: [PATCH] Markdownify readme
---
README => README.mkd | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
rename README => README.mkd (65%)
diff --git a/README b/README.mkd
similarity index 65%
rename from README
rename to README.mkd
index 97125fc..7781a53 100644
--- a/README
+++ b/README.mkd
@@ -1,5 +1,5 @@
Haskell Report README
-~~~~~~~~~~~~~~~~~~~~~
+---------------------
These are the sources to the Haskell report, including all the source
files you will need to generate either the PDF or the HTML version of
@@ -7,37 +7,37 @@ the report.
Tools you will need
-~~~~~~~~~~~~~~~~~~~
+-------------------
-PDF version: a decent LaTeX installation with pdflatex. We use the
+PDF version: a decent LaTeX installation with `pdflatex`. We use the
following additional packages:
- - times
- - makeidx
- - graphicx
- - url
- - color
- - hyperref
+ - `times`
+ - `makeidx`
+ - `graphicx`
+ - `url`
+ - `color`
+ - `hyperref`
Also you need the following tools
- - makeindex
+ - `makeindex`
all of which are usually available with a good TeX distribution
(e.g. TeX Live).
The following are also required for building the tools:
- - flex
- - GHC
+ - `flex`
+ - GHC
The HTML version additionally requires
- - tex4ht (e.g. install 'tex4ht' on a Debian or Ubuntu system, or
- 'tetex-tex4ht' on a Fedora system)
+ - `tex4ht` (e.g. install `tex4ht` on a Debian or Ubuntu system, or
+ `tetex-tex4ht` on a Fedora system)
Building the report
-~~~~~~~~~~~~~~~~~~~
+-------------------
Firstly:
@@ -52,14 +52,14 @@ Then you should be able to say
This will create:
- - PDF version: report/haskell.pdf
-
- - HTML version: report/ht/haskell.html
- (NB. requires report/ht/*.{html,png,css})
+- PDF version: report/haskell.pdf
+
+- HTML version: report/ht/haskell.html
+ (NB. requires report/ht/*.{html,png,css})
Roadmap
-~~~~~~~
+-------
SOURCE FILES
@@ -73,6 +73,6 @@ SOURCE FILES
.verb files
-~~~~~~~~~~~
+-----------
--
GitLab