Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/carsonip/hugo-theme-minos.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarson Ip <carsonip715@gmail.com>2017-02-20 23:01:14 +0300
committerCarson Ip <carsonip715@gmail.com>2017-02-20 23:01:14 +0300
commit6ac12d23d748ee47e69cfbe331e93611df027f6a (patch)
treef61c1f3aa964b91e335826a513151b4786a2efb2
parentca2b12b22d15b60a7fba175d5efad40f239ca276 (diff)
Update readme
-rw-r--r--README.md59
1 files changed, 54 insertions, 5 deletions
diff --git a/README.md b/README.md
index 80add1f..44f4a40 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,35 @@
# Minos
-Minos is a hugo theme ported from Hexo theme [Minos](https://github.com/ppoffice/hexo-theme-minos) by [@ppoffice](https://github.com/ppoffice/).
+**_A simple and retro styled Hexo theme, concentrated more on your ideas._**
-Work in progress.
+Minos is a hugo theme ported from Hexo theme [Minos](https://github.com/ppoffice/hexo-theme-minos). Requires Hugo v0.15+.
-## Site Params
+## Features
+
+* Everything in the original Mino theme, except
+ * Gallery (fancybox)
+ * Duoshuo comment
+ * Search box
+* Disqus
+* Google Analytics
+* [KaTeX](https://github.com/Khan/KaTeX)
+
+## Installation
+
+To install Minos as your theme, first clone this repository in the `themes/` directory:
+
+```
+$ cd themes/
+$ git clone --depth 1 https://github.com/carsonip/hugo-theme-minos
+```
+
+Second, specify `hugo-theme-minos` as your default theme in the config.toml file. Just add the line
+
+```
+theme = "hugo-theme-minos"
+```
+
+## Options
### Disqus
```
@@ -18,8 +43,32 @@ Work in progress.
googleAnalytics = "UA-123-45"
```
-### [KaTeX](https://github.com/Khan/KaTeX)
+### KaTeX
```
[params]
katex = true
-``` \ No newline at end of file
+```
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Original Author
+
+PPOffice
+
+* https://github.com/ppoffice
+
+## Ported by
+
+Carson Ip
+
+* https://github.com/carsonip
+
+## License
+
+Licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. \ No newline at end of file