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

github.com/darshanbaral/kitab.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 25 insertions, 2 deletions
diff --git a/README.md b/README.md
index a07a20f..8ded7c2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
-# kitab
-A hugo theme for publishing books
+# kitab theme
+
+The kitab Theme is a simple theme meant for publishing books.
+
+## Installation
+
+Inside the folder of your Hugo site run:
+
+ $ cd themes
+ $ git clone https://github.com/darshanbaral/kitab.git
+
+For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
+
+## Getting started
+
+After installing the kitab Theme successfully, modify the `config.toml` as you wish.
+
+### The config file
+
+You'll find a file called [`config.toml`](https://github.com/darshanbaral/kitab/blob/master/exampleSite/config.toml). Copy the `config.toml`to the root folder of your Hugo site and customize it per your need.
+
+## Adding books
+
+- Create a folder inside the `content` folder for each book
+- Add `_index.md` inside the folder for book with meta data such as book title, author, and date.