summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIain McGinniss <iainmcgin@gmail.com>2013-02-20 12:39:45 +0000
committerIain McGinniss <iainmcgin@gmail.com>2013-02-20 12:39:45 +0000
commit54273a3e97145841eb3f745888dbdc689bd59d1c (patch)
tree26079d41f82958bbd1877da4a400b0c08c2a904f /README.md
parent1352994346ee78a0d4140c65e61822aca12229c2 (diff)
downloadscala-54273a3e97145841eb3f745888dbdc689bd59d1c.tar.gz
scala-54273a3e97145841eb3f745888dbdc689bd59d1c.tar.bz2
scala-54273a3e97145841eb3f745888dbdc689bd59d1c.zip
set Luxi Mono and Heuristica (Utopia) as the default fonts for
monospace and main text respectively for PDF output. Added notes on required packages to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/README.md b/README.md
index 757e1a6134..70b7b8bad3 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,37 @@
Scala Language Reference as Pandoc Markdown - Notes
===================================================
-General
+Prerequisites
+-------------
+
+In order to build the scala reference, you will require the following
+software packages:
+
+- Pandoc v1.10.1 or higher (http://johnmacfarlane.net/pandoc/)
+- TeX-Live (https://www.tug.org/texlive/)
+- The luximono font - this does not ship with TeX-Live by default due to
+ license restrictions, but it can be easily installed using
+ the ["getnonfreefonts" script](https://www.tug.org/fonts/getnonfreefonts/).
+ A short guide on using this to get luximono can be found on the
+ TeX Stackexchange [here](http://tex.stackexchange.com/questions/22157/how-to-use-the-luximono-font-with-tex-live).
+- The Heuristica font - this is an extension of the free version of the Adobe
+ Utopia font. This must be installed as a system font for the PDF to
+ build, and you can find the appropriate font package for your system
+ here: https://code.google.com/p/evristika/
+
+
+General Advice for editors
-------
- All files must be saved as UTF-8: ensure your editors are configured
appropriately.
+- Leave two empty lines between each section, regardless of level of nesting.
+ Leave two empty lines at the end of every markdown file that forms a part
+ of the main specification when compiled.
- Use of the appropriate unicode characters instead of the latex modifiers
for accents, etc. is necessary. For example, é instead of \'e. Make use of
the fact that the content is unicode, google the necessary characters if
you don't know how to type them directly.
-- Leave two empty lines between each section, regardless of level of nesting.
- Leave two empty lines at the end of every markdown file that forms a part
- of the main specification when compiled.
Conversion from LaTeX - Guidelines
----------------------------------