1 files changed, 45 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..3f2b140
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+ian-presentation is a class for typesetting presentations in LaTeX. It is
+designed with simplicity in mind, and only provides a few features.
+
+
+* Usage
+
+  ian-presentation reports the slide number and the total number of slides,
+  provided the 'pagestyle' is set to 'plain'. The slide number is stored in the
+  \page counter.
+
+  ian-presentation defines a command to display the title of a slide, with the
+  syntax:
+    \title{The Title}
+
+  To create a new slide, one has to insert a page break, for instance by using
+  the TeX commands
+    \vfill
+    \eject
+
+  ian-presentation defines an 'itemize' environment, which is similar to the
+  usual one:
+    \begin{itemize}
+      \item Item
+      \item Item
+    \end{itemize}
+  If an itemize is nested inside another, the bullet point will be changed to a
+  triangle and the indent is increased.
+
+  ian-presentation defines an 'enumerate' environment, which functions like
+  'itemize', except it numbers each entry. Enumerates should not be nested
+  (unsupported for now).
+
+  See the bundled 'example.tex' file for a usage example.
+
+
+* Requirements:
+  pdflatex
+  amssymb
+
+
+* Authors:
+  ian-presentation was written by Ian Jauslin.
+
+
+copyright Ian Jauslin 2021.