From 1ce153b4097c9fcedef1758c74d16e2a06d8c9c2 Mon Sep 17 00:00:00 2001
From: He Yeshuang <yeshuanghe@gmail.com>
Date: Sun, 17 May 2020 00:07:29 +0800
Subject: prepare for publish

---
 README.md | 88 +++++++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 54 insertions(+), 34 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 20ec646..0e726fd 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,57 @@
-# Starter Theme for [Hugo](http://gohugo.io/)
-
-[Hugo Static Site Generator Blank Starter Theme](https://jimfrenette.com/2019/02/hugo-static-site-generator-blank-starter-theme/)
-
-## Installation
-
-For example, if your Hugo website is in the `www` folder.
+# Theme Tokiwa for [Hugo](http://gohugo.io/)
+
+Tokiwa-iro is the main color tone and the name of this theme.
+
+Built on the top of [Hugo Static Site Generator Blank Starter Theme](https://jimfrenette.com/2019/02/hugo-static-site-generator-blank-starter-theme/).
+
+## Screenshot
+
+![1](images/screenshot.png)
+
+## available config params
+
+```toml
+disqusShortname = "YOURSHORTNAME"
+googleAnalytics = "UA-1234567890"
+
+[params]
+description = """
+Tokiwa-iro is the theme color of this site.
+"""
+math = true # for introducing $KaTEX$
+env = "production" # for Google Analytics and DISQUS.
+
+[menu]
+# Shown in the side menu.
+  [[menu.main]]
+    name = "cat"
+    pre = "<i class='fa fa-list fa-fw'></i>"
+    weight = 1
+    identifier = "post"
+    url = "/post/"
+  [[menu.main]]
+    name = "Tags"
+    pre = "<i class='fa fa-tags fa-fw'></i>"
+    url = "/tags/"
+    weight = 2
+
+[social]
+twitter="http://twitter.com/hh"
+instagram="http://twitter.com/hh"
+gitlab="http://twitter.com/hh"
+youtube="http://twitter.com/hh"
+github="http://github.com/hh"
 ```
-cd www
-
-git init
-
-git submodule add https://github.com/jimfrenette/hugo-starter.git themes/starter
-```
-
-## Dev Hugo Templates
 
-```
-cd www
+A complete `config.toml` is in the `exampleSite` folder.
 
-hugo server -D
-```
-Preview the site, e.g., [`localhost:1313`](http://localhost:1313/)
 
-## Webpack Dev UI
+## Dev this Templates
 
 Install node modules
 
 ```
-cd www/themes/starter
+cd blog/themes/hugo-theme-tokiwa
 
 npm i
 ```
@@ -35,7 +59,7 @@ npm i
 Unminified development build with sourcemaps
 
 ```
-cd www/themes/starter
+cd blog/themes/hugo-theme-tokiwa
     
 npm run dev
 ```
@@ -43,20 +67,16 @@ npm run dev
 Build for production with npm run build. CSS and JavaScript files will be output into the starter themes dist folder. e.g.,
 
 ```
-cd www/themes/starter
+cd blog/themes/hugo-theme-tokiwa
     
 npm run build
 ```
 
-## Comments
-
-To enable DISQUS comments, add `disqusShortname = YOURSHORTNAME` to your config file.
-
+## Credit
 
-## Production
+* [hugoBasicExample](https://github.com/gohugoio/hugoBasicExample.git) is used to mock data.
+* [Hugo Static Site Generator Blank Starter Theme](https://jimfrenette.com/2019/02/hugo-static-site-generator-blank-starter-theme/)
+* Font `杨任东竹石体` is used for the banner. Non-Chinese user may want to delete `/static/fonts` to reduce the size.
+* Beautiful icons made by [Remix-Design](https://github.com/Remix-Design/remixicon).
 
-To run in production (e.g. to have Google Analytics show up), run `HUGO_ENV=production` before your build command. For example:
-
-```
-HUGO_ENV=production hugo
-```
+Thanks.
\ No newline at end of file
-- 
cgit v1.2.3