summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAdriaan Moors <adriaan.moors@typesafe.com>2014-03-10 19:34:00 -0700
committerAdriaan Moors <adriaan.moors@typesafe.com>2014-03-10 20:03:10 -0700
commitb75812d518cf672c90a903b33625f52c75b3c8f9 (patch)
tree3e9c8a1a77414eb7da57d644a3229e92bbf9674c /README.md
parent90314673008a3bf765cf72d8cbbd3c691f27af03 (diff)
downloadscala-b75812d518cf672c90a903b33625f52c75b3c8f9.tar.gz
scala-b75812d518cf672c90a903b33625f52c75b3c8f9.tar.bz2
scala-b75812d518cf672c90a903b33625f52c75b3c8f9.zip
Mention WIP in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md
index b85d8b53d5..84e9d6abc9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,19 @@
-# Scala Language Reference as Pandoc Markdown - Notes
+# Scala Language Reference as Markdown
+
+I'm working towards making this the official Scala Reference.
+I'm migrating the pandoc setup to something that can easily be maintained and viewed as-is on github.
+
+I'd like a lightweight setup that produces an html + mathjax version of the markdown in this repo on every commit. Should be easy with Travis CI. Eventually, we should also generate a pdf, but the main priority is ease of maintenance, readability on github.
+
+This spec should now also be up to date with the latex one at scala/scala-dist, which will be decommissioned.
+
+Notes to self:
+- http://docs.mathjax.org/en/latest/start.html
+- http://doswa.com/2011/07/20/mathjax-in-markdown.html
+
+# Scala Language Reference as Pandoc Markdown - Original Notes
+
+TODO: this needs to be updated
## Prerequisites