update docs and example config.toml

README.md

@@ -15,19 +15,41 @@ Simple, text-focussed and minimal personal portfolio theme based on https://gith
 
 ## Installation
 
-cd into your hugo site's root directory and:
+### Installing Hugo
 
 ```sh
-cd themes
+# For Linux
-git clone https://github.com/invinciblycool/lekh.git
+sudo apt-get install hugo
+
+# For Mac
+brew install hugo
+
+# Detailed instructions at https://gohugo.io/getting-started/installing#readout
 ```
 
-For more information read the [official setup guide](https://gohugo.io/overview/installing/) of Hugo.
+### Creating a new site
+
+```sh
+hugo new site <site_name>
+```
+
+### Adding lekh as a theme
+
+```sh
+cd <site_name>
+git init
+git submodule add https://github.com/ba11b0y/lekh.git themes/lekh
+echo theme = \"lekh\" >> config.toml
+
+```
+
+Here's Hugo's [official guide](https://gohugo.io/getting-started/quick-start/) for more details.
 
 
 ## Personalization
 
-To personalize the theme
+Hugo looks for a `config.toml` in the root of your site.
+To personalize the theme, copy the default config shipped with the theme
 
 `cp themes/lekh/exampleSite/config.toml config.toml`
 
@@ -37,29 +59,29 @@ Or simply copy the below config and customize accordingly.
 
 ```toml
 
-baseURL = "http://rtiwari.me/"
+baseURL = "https://example.com/"
 languageCode = "en-us"
-title = "Rahul Tiwari"
+title = "Example Lekh Site"
 theme = "lekh"
 
 [params]
-Name = ""
+Name = "Agent Smith"
-Email = ""
+Email = "agentsmith@thematrix.com"
 Resume = "" # Add the filename with file extension.
 PostLimit = 4 # Sets the number of posts to display on the front page
 GoatCounterCode = ""
 
 [[params.profiles]]
 name = "GitHub"
-url = ""
+url = "https://github.com/ba11b0y"
 
 [[params.profiles]]
 name = "Twitter"
-url = ""
+url = "https://twitter.com/ba11b0y"
 
 [[params.profiles]]
 name = "Goodreads"
-url = ""
+url = "https://www.goodreads.com/user/show/91520565-rahul-tiwari"
 
 [[params.profiles]]
 name = "LinkedIn"
@@ -67,20 +89,22 @@ url = ""
 
 ```
 
-## Posts
+## Creating posts
 
-Below is a typical post, which defaults to what Hugo expects.
+```sh
+# This creates a new draft post in content/posts
+hugo new posts/title-of-post.md
+```
 
-Specify `draft: true` to avoid publishing the post.
+## Serving it up
 
-```md
+```sh
----
+# This will show up your draft posts as well.
-title: "Rant post"
+hugo server -D
-date: "2020-04-02"
+#OR
-draft: true
----
 
-Too much to rant :(
+#This will show up only your published posts.
+hugo server
 ```
 
 ## Credits

exampleSite/config.toml

@@ -1,26 +1,26 @@
-baseURL = "http://rtiwari.me/"
+baseURL = "https://example.com/"
 languageCode = "en-us"
-title = "Rahul Tiwari"
+title = "Example Lekh Site"
 theme = "lekh"
 
 [params]
-Name = ""
+Name = "Agent Smith"
-Email = ""
+Email = "agentsmith@thematrix.com"
 Resume = "" # Add the filename with file extension.
 PostLimit = 4 # Sets the number of posts to display on the front page
 GoatCounterCode = ""
 
 [[params.profiles]]
 name = "GitHub"
-url = ""
+url = "https://github.com/ba11b0y"
 
 [[params.profiles]]
 name = "Twitter"
-url = ""
+url = "https://twitter.com/ba11b0y"
 
 [[params.profiles]]
 name = "Goodreads"
-url = ""
+url = "https://www.goodreads.com/user/show/91520565-rahul-tiwari"
 
 [[params.profiles]]
 name = "LinkedIn"

theme.toml

@@ -1,8 +1,8 @@
 name = "Lekh"
 license = "MIT"
-licenselink = "https://github.com/invinciblycool/lekh/blob/master/LICENSE.md"
+licenselink = "https://github.com/ba11b0y/lekh/blob/master/LICENSE.md"
 description = "A text focussed and minimal personal portfolio theme with dark mode."
-homepage = "https://github.com/invinciblycool/lekh"
+homepage = "https://github.com/ba11b0y/lekh"
 tags = ["minimal", "clean", "blog", "responsive", "personal", "simple", "minimalist", "portfolio", "text-focussed", "dark", "dark-mode", "rss"]
 features = ["blog", "Clean and minimal", "Responsive", "Social media links", "Markdown", "Text focussed", "Dark mode", "RSS feeds"]
 min_version = "0.38"