]> njoseph.me Git - hyde.git/commitdiff
Add installation section
authorPedro Melo <melo@simplicidade.org>
Tue, 26 Jul 2016 12:27:07 +0000 (13:27 +0100)
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Tue, 26 Jul 2016 12:27:07 +0000 (14:27 +0200)
README.md

index 0235f169cfab9e4b1a698be3d65d5405568ccfb3..45ee21fa62fc34a52d637d9c9d66d5507497c136 100644 (file)
--- 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.