summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIain McGinniss <iainmcgin@gmail.com>2013-02-19 15:20:49 +0000
committerIain McGinniss <iainmcgin@gmail.com>2013-02-19 15:20:49 +0000
commitab50eec9e27e0820340658d55967d3446f5ba0ff (patch)
treeb4799a2305b10b1bddb11b50f7fd0676965a40f2
parent94198c735d96de2d7fd247f3a16e5a2d79c770ed (diff)
downloadscala-ab50eec9e27e0820340658d55967d3446f5ba0ff.tar.gz
scala-ab50eec9e27e0820340658d55967d3446f5ba0ff.tar.bz2
scala-ab50eec9e27e0820340658d55967d3446f5ba0ff.zip
using standard markdown for numbered lists (hopefully better
rendering on github) added note on todo command conversion
-rw-r--r--README.md41
1 files changed, 21 insertions, 20 deletions
diff --git a/README.md b/README.md
index 5f16ecd81d..757e1a6134 100644
--- a/README.md
+++ b/README.md
@@ -19,26 +19,26 @@ Conversion from LaTeX - Guidelines
### Chapter conversion Checklist
-#. Convert all `\section{...}`
-#. Convert all `\subsection{...}`
-#. Convert all `\subsubsection{...}`
-#. Convert all `{\em ...}`
-#. Convert all `\lstlisting`
-#. Convert all `\lstinline`
-#. Convert all `\code`
-#. Convert all `\sref{sec:...}`
-#. Convert all `\begin{itemize}`
-#. Convert all `\begin{enumerate}`
-#. Convert all `\example`
-#. Convert all `\footnote`
-#. Convert all `\paragraph`
-#. Convert all `\begin{quote}`
-#. Delete all `\comment{...}`
-#. Convert all single quote pairs
-#. Convert all double quote pairs
-#. Look for manually defined enumerated lists (1. 2. 3. etc)
-#. Remove `%@M` comments
-#. Convert all extra macros (`\commadots`, etc)
+1. Convert all `\section{...}`
+1. Convert all `\subsection{...}`
+1. Convert all `\subsubsection{...}`
+1. Convert all `{\em ...}`
+1. Convert all `\lstlisting`
+1. Convert all `\lstinline`
+1. Convert all `\code`
+1. Convert all `\sref{sec:...}`
+1. Convert all `\begin{itemize}`
+1. Convert all `\begin{enumerate}`
+1. Convert all `\example`
+1. Convert all `\footnote`
+1. Convert all `\paragraph`
+1. Convert all `\begin{quote}`
+1. Delete all `\comment{...}`
+1. Convert all single quote pairs
+1. Convert all double quote pairs
+1. Look for manually defined enumerated lists (1. 2. 3. etc)
+1. Remove `%@M` comments
+1. Convert all extra macros (`\commadots`, etc)
### Code
@@ -120,6 +120,7 @@ compromise came up with here was to treat definitions like quotations:
`` `like this` ``.
- `\paragraph` (typically used for a non-numbered header) can be replaced by
a hard line break, which is a `\` followed immediately by a newline.
+- `\TODO` can be replaced by a markdown comment `<!-- TODO: ... -->`
### Unicode Character replacements