aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMohammad Akhlaghi <mohammad@akhlaghi.org>2019-11-21 17:21:29 +0000
committerMohammad Akhlaghi <mohammad@akhlaghi.org>2019-11-21 17:21:29 +0000
commit0c33fe1697ba672b80e2a064d3bbedbdfd5592fa (patch)
treed4bd01fc83c9c90ba651c346350299b1299adce3
parent8b006f31cd8d3d21bbd4fa0a7b0f722fe8cb497b (diff)
Added README to introduce the contents
The newly created `README.md' gives a short description of the project, with a link to the final PDF, and the main template Gitlab page, along with a short description of the LaTeX dependencies and how to build the PDF.
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..988aff1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+Slides to introduce the reproducible paper template
+===================================================
+
+Copyright (C) 2018-2019 Mohammad Akhlaghi <mohammad@akhlaghi.org>\
+See the end of the file for license conditions.
+
+This is the LaTeX source of the slides presenting the [Reproducible
+paper template](https://gitlab.com/makhlaghi/reproducible-paper). The
+most recent version of the slides is available at
+https://akhlaghi.org/pdf/reproducible-paper.pdf .
+
+To build the slides, you need to have the Beamer and Tikz LaTeX
+packages installed, then simply run this command.
+
+```(shell)
+$ make
+```
+
+Note that the `Makefile` will create a `git-commit.tex` file before
+running LaTeX. So if you want to run LaTeX directly, make this file
+manually, see the `Makefile` for the suggested command to generate it. \ No newline at end of file