Initial commitHEADmain

1 files changed, 54 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7c3bec1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# IBeaMer
+
+LaTeX/Beamer templates using the [IBM design
+language](https://www.ibm.com/design/language).
+
+### Fonts
+
+See `ibeamer.tex` for example usage and `ibeamer.pdf` for a sample.
+
+This template uses the [Lete Sans Math](https://github.com/abccsss/LeteSansMath)
+and [IBM Plex](https://github.com/IBM/plex) fonts.
+
+These may already part of your system's `texlive` distribution. On archlinux,
+for example, they are part of the `texlive-fontsextra` package. If not, they are
+both licensed with the [OFL `v1.1`](https://openfontlicense.org) and can be
+freely downloaded from their github sources. They are also available on CTAN
+([LeteSansMath](https://ctan.org/pkg/lete-sans-math),
+[Plex](https://ctan.org/pkg/plex-otf)), if that is easier to integrate into your
+LaTeX workflow.
+
+In total, the following font files will be needed
+
+* `IBMPlexMono-Regular.otf`
+* `IBMPlexSans-Italic.otf`
+* `IBMPlexSans-Regular.otf`
+* `LeteSansMath.otf`
+
+Because we are using non-standard fonts, this will need to be compiled use
+`lualatex`. For example, `latexmk -pdflua ibeamer.tex`.
+
+### Installation
+
+To use this package, clone this repository into your
+[`$TEXMFHOME`](https://www.tug.org/texlive/doc/texlive-en/texlive-en.html)
+directory. For example
+
+    git clone https://git.rueg.re/ibeamer "$TEXMFHOME/ibeamer"
+
+If your `$TEXMFHOME` is not set, choose a location for it and `export` it in
+your shell configuration file. For example, create the directory
+
+    mkdir -p "$HOME/.local/share/tex"
+
+and add
+
+    export TEXMFHOME=$HOME/.local/share/tex
+
+to your `$HOME/.bashrc` (or `$HOME/.zshrc` on MacOS).
+
+(Note: `$HOME/.local/share` is the default location for
+[`$XDG_DATA_HOME`](https://wiki.archlinux.org/title/XDG_Base_Directory), but you
+can pick any directory).
+
+Then you can use the `ibeamer.tex` template from anywhere in your filesystem.