aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Roques <olivier@oroques.dev>2020-08-02 21:11:33 +0200
committerOlivier Roques <olivier@oroques.dev>2020-08-02 21:11:33 +0200
commit8ae98184e640112d7d817c68ac1bd0889d3fafbe (patch)
treed0c0dd6f94e8401fbd89a7ba3a999d403e308a03
parent74058f0cae8eff8b83d02303671c0532bd492ea3 (diff)
Update README.md
-rw-r--r--README.md20
-rw-r--r--exampleSite/config.toml2
-rw-r--r--images/screenshot.pngbin0 -> 83901 bytes
-rw-r--r--images/tn.pngbin0 -> 53903 bytes
4 files changed, 21 insertions, 1 deletions
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
--- /dev/null
+++ b/images/screenshot.png
Binary files differ
diff --git a/images/tn.png b/images/tn.png
new file mode 100644
index 0000000..3fb2620
--- /dev/null
+++ b/images/tn.png
Binary files differ