From 8ae98184e640112d7d817c68ac1bd0889d3fafbe Mon Sep 17 00:00:00 2001 From: Olivier Roques Date: Sun, 2 Aug 2020 21:11:33 +0200 Subject: Update README.md --- README.md | 20 ++++++++++++++++++++ exampleSite/config.toml | 2 +- images/screenshot.png | Bin 0 -> 83901 bytes images/tn.png | Bin 0 -> 53903 bytes 4 files changed, 21 insertions(+), 1 deletion(-) create mode 100644 images/screenshot.png create mode 100644 images/tn.png diff --git a/README.md b/README.md index baf333c..ed035a2 100644 --- a/README.md +++ b/README.md @@ -3,5 +3,25 @@ A simple monospaced resume theme for Hugo. It was ported from the Jekyll theme [ankitsultana/researcher](https://github.com/ankitsultana/researcher). +## Screenshot +![thumbnail](https://github.com/ojroques/hugo-researcher/blob/master/images/tn.png) + +## Installation +Add the theme to your site's `themes` directory: +```bash +mkdir themes # if the themes folder does not exist +git clone https://github.com/ojroques/hugo-researcher themes/researcher +``` + +Update the theme option in `config.toml`: +```toml +theme = "researcher" +``` + +## Configuration +A self-explanatory configuration file is present in +[exampleSite/config.toml](https://github.com/ojroques/hugo-researcher/blob/master/exampleSite/config.toml), +along the files of a demo website. + ## License [GPL-3.0 License](https://github.com/ojroques/hugo-researcher/blob/master/LICENSE) diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 7fdd911..cd2e81f 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -29,4 +29,4 @@ enableEmoji = true weight = 3 [markup.goldmark.renderer] - unsafe = true + unsafe = true # allow raw HTML in markdown files diff --git a/images/screenshot.png b/images/screenshot.png new file mode 100644 index 0000000..d6d0169 Binary files /dev/null and b/images/screenshot.png differ diff --git a/images/tn.png b/images/tn.png new file mode 100644 index 0000000..3fb2620 Binary files /dev/null and b/images/tn.png differ -- cgit v1.2.3