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

github.com/darshanbaral/khata.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDarshan Baral <darshanbaral@users.noreply.github.com>2019-07-03 06:58:42 +0300
committerGitHub <noreply@github.com>2019-07-03 06:58:42 +0300
commite74026ec0a93d66f69b66bf6d23fd24c4dcd5694 (patch)
tree9dd2ecb8d9256635282fea5c1cd5d683550a7050
parent3d7f56f52a2c825cf1f8c307e8483a927aec714a (diff)
Update README.md
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index cc5f703..28fbe77 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
-# khata Theme \ No newline at end of file
+# khata Theme
+
+The khata Theme is a hugo theme for documentation and note keeping.
+
+## Installation
+
+Inside the folder of your Hugo site run:
+
+ $ cd themes
+ $ git clone https://github.com/darshanbaral/khata.git
+
+For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
+
+## Getting started
+
+After installing the aafu Theme successfully, modify the `config.toml` as you wish to generate your online resume.
+
+### The config file
+
+You'll find a file called [`config.toml`](//github.com/darshanbaral/khata/blob/master/exampleSite/config.toml). Copy the `config.toml`to the root folder of your Hugo site and customize it per your need.
+
+### Add your photo
+
+The image to use as profile photo can be specified in the `config.toml`. You can also add the photo to the `static` folder and provide a relative link to the photo.