diff options
author | Olivier Roques <olivier@oroques.dev> | 2020-08-02 21:11:33 +0200 |
---|---|---|
committer | Olivier Roques <olivier@oroques.dev> | 2020-08-02 21:11:33 +0200 |
commit | 8ae98184e640112d7d817c68ac1bd0889d3fafbe (patch) | |
tree | d0c0dd6f94e8401fbd89a7ba3a999d403e308a03 /README.md | |
parent | 74058f0cae8eff8b83d02303671c0532bd492ea3 (diff) |
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
@@ -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) |