summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md')
-rw-r--r--macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md46
1 files changed, 44 insertions, 2 deletions
diff --git a/macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md b/macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md
index e22c28ec14..0387bc4765 100644
--- a/macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md
+++ b/macros/latex/contrib/beamer-contrib/themes/beamerthemenord/README.md
@@ -1,11 +1,53 @@
-# beamerthemeNord
+# The Nord Beamer Theme
-A simple beamer theme using [Nord](https://www.nordtheme.com/) color theme.
+A beamer theme using [Nord](https://www.nordtheme.com/) color scheme.
+
+Pull requests and issues are welcome.
+
+## News
+
+- This theme is now available both at see [CTAN](https://ctan.org/pkg/beamerthemenord) (see [CTAN announcement](https://ctan.org/ctan-ann/id/mailman.2913.1593882783.3866.ctan-ann@ctan.org)) and [Overleaf](https://www.overleaf.com/latex/templates/beamerthemenord/xyjjhcsyyjbr).
+
+- Added light/dark style option
+
+## Installation
+
+### Tex Live / MacTeX
+
+[Tex Live](https://www.tug.org/texlive/) and [MacTeX](https://www.tug.org/mactex/) users can install/update **beamerthemeNord** by using
+```sh
+tlmgr update --self beamerthemenord
+```
+
+### Manual
+
+If you want to customize this theme, you can also clone this repository and copy all `*.sty` files into the directory where you main `tex` source file is.
## Usage
See [beamerthemeNord.pdf](./beamerthemeNord.pdf) or [beamerthemeNord.tex](./beamerthemeNord.tex)
+**Note**: This theme currently only supports XeLaTeX, which is convinent to use system-wide fonts and to write in non-ASCII characters.
+You are weclome to contribute on compatability for other TeX distributions.
+
+## Screenshots
+
+Light Style | Dark Style
+----------------------------------------|---------------------------------------
+![](./screenshots/light-titlepage.png) | ![](./screenshots/dark-titlepage.png)
+![](./screenshots/light-usage.png) | ![](./screenshots/dark-usage.png)
+![](./screenshots/light-colors.png) | ![](./screenshots/dark-colors.png)
+![](./screenshots/light-fonts.png) | ![](./screenshots/dark-fonts.png)
+![](./screenshots/light-blocks.png) | ![](./screenshots/dark-blocks.png)
+![](./screenshots/light-toc.png) | ![](./screenshots/dark-toc.png)
+
+
+## Usecases
+
+Please send a pull request to add your usecase
+
+- [Ph.D. defense of Junwei Wang](https://junwei-wang.github.io/pdfs/slides/2020-phd-defense-handout.pdf)
+
## Maintainer
Junwei Wang (i.junwei.wang@gmail.com)