summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPedro Melo <melo@simplicidade.org>2016-07-26 13:27:07 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2016-07-26 14:27:07 +0200
commitfff9d5b21f50bbe11e9b9329867d6f70669de81f (patch)
tree85661f1e4c67e8fa4adbf3dd9af5be61f988a672
parenta04b9e15746f679a3a6d8f325b82e2392b20d380 (diff)
Add installation section
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0235f16..45ee21f 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ It pairs a prominent sidebar with uncomplicated content.
## Contents
+- [Installation](#installation)
- [Options](#options)
- [Sidebar menu](#sidebar-menu)
- [Sticky sidebar content](#sticky-sidebar-content)
@@ -19,6 +20,20 @@ It pairs a prominent sidebar with uncomplicated content.
- [License](#license)
+## Installation
+
+To install Hyde as your default theme, first install this repository in the `themes/` directory:
+
+ $ cd themes/
+ $ git clone https://github.com/spf13/hyde.git
+
+Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
+
+ theme = "hyde"
+
+at the top of the file.
+
+
## Options
Hyde includes some customizable options, typically applied via classes on the `<body>` element.