aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: ed035a2362bc79b11f0b64cf4cb217aa0322442d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Researcher

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)