add readme and screenshots

This commit is contained in:
Yihui Xie 2017-06-15 23:08:08 -05:00
parent ec81eb1d4a
commit 13901ba8b4
3 changed files with 28 additions and 0 deletions

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# HUGO XMIN
## _Keep it simple, but not simpler_
**XMin** is a Hugo theme written by [Yihui Xie](https://yihui.name) in about four hours: half an hour was spent on the Hugo templates, and 3.5 hours were spent on styling. The main motivation for writing this theme was to provide a really minimal example to beginners of Hugo templates. This XMin theme contains about 130 lines of code in total, including the code in HTML templates and CSS (also counting empty lines).
```bash
find . -not -path '*/exampleSite/*' \( -name '*.html' -o -name '*.css' \) | xargs wc -l
```
```
5 ./layouts/404.html
18 ./layouts/_default/list.html
12 ./layouts/_default/single.html
16 ./layouts/_default/terms.html
0 ./layouts/partials/foot_custom.html
9 ./layouts/partials/footer.html
0 ./layouts/partials/head_custom.html
19 ./layouts/partials/header.html
7 ./static/css/fonts.css
50 ./static/css/style.css
136 total
```
I can certainly further reduce the code, for example, by eliminating the CSS, but I believe a tiny bit CSS can greatly improve readability. You cannot really find many CSS frameworks that only contain 50 lines of code.
![Screenshot](/images/screenshot.png)

BIN
images/screenshot.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

BIN
images/tn.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB