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

github.com/mazgi/hugo-theme-techlog-simple.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHidenori MATSUKI <MATSUKI.Hidenori@gmail.com>2018-11-26 20:18:27 +0300
committerHidenori MATSUKI <MATSUKI.Hidenori@gmail.com>2018-11-26 20:18:27 +0300
commite8ea801b21adaf23683c1b5326119eeced6eb584 (patch)
treef012f6b8db84138106b49ce156a03788e0622769
parent43758a59b1fcf88e308ae6a319069a42cca9ccf6 (diff)
Add basic information into README like https://github.com/budparr/gohugo-theme-ananke.v1.0.0
ref: https://github.com/gohugoio/hugoThemes/issues/444#issuecomment-429526141
-rw-r--r--README.md47
1 files changed, 45 insertions, 2 deletions
diff --git a/README.md b/README.md
index cce6bd9..57142de 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,48 @@
-# hugo-theme-techlog-simple
+# Techlog Simple, A simple theme for [Hugo](https://gohugo.io/).
[![CircleCI](https://circleci.com/gh/mazgi/hugo-theme-techlog-simple.svg?style=svg)](https://circleci.com/gh/mazgi/hugo-theme-techlog-simple)
-Example: https://mazgi-hugo-themes-gcp.firebaseapp.com/techlog-simple/
+![screenshot](https://raw.githubusercontent.com/mazgi/hugo-theme-techlog-simple/master/images/screenshot.png)
+
+[DEMO](https://mazgi-hugo-themes-gcp.firebaseapp.com/techlog-simple/)
+
+Features
+
+- Simple
+- Table of Contents
+- Custom profile page.
+
+Also includes examples of Hugo Features or Functions:
+
+- Pagination
+- Tags
+- Authors
+
+## Installation
+
+Inside the folder of your Hugo site run:
+
+ $ cd themes
+ $ git clone https://github.com/mazgi/hugo-theme-techlog-simple.git
+
+## Getting started
+
+After installing the theme successfully it requires a just a few more steps to get your site running.
+
+### The config file
+
+Take a look inside the [`exampleSite`](https://github.com/mazgi/hugo-theme-techlog-simple/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/mazgi/hugo-theme-techlog-simple/blob/master/exampleSite/config.toml). To use it, copy the [`config.toml`](https://github.com/mazgi/hugo-theme-techlog-simple/blob/master/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change the strings in this theme.
+
+### Nearly finished
+
+In order to see your site in action, run Hugo's built-in local server.
+
+`$ hugo server`
+
+Now enter [`localhost:1313`](http://localhost:1313/) in the address bar of your browser.
+
+To run in production (e.g. to have Google Analytics show up), run `HUGO_ENV=production` before your build command. For example:
+
+```shellsession
+$ HUGO_ENV=production hugo
+```