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

github.com/Vimux/Binario.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorvimux <vimux@protonmail.com>2018-06-20 10:49:27 +0300
committervimux <vimux@protonmail.com>2018-06-20 10:49:27 +0300
commita2f0d83b61428396f9ab5ee446526f9e5dce315d (patch)
tree86f9960fa958e41cb2b0f22d98c6cfc696be0450 /README.md
parentc06074a6977b8b2f888f9a5ad116700291b4a3ac (diff)
Update README.md: add installation guide
Diffstat (limited to 'README.md')
-rw-r--r--README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md
index 91eb514..5287a40 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,58 @@
* Related content
* MathJax
+## Installation
+
+*First of all, you will need to [install Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and [create new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site).* After that, you ready to install **Binario**.
+
+There are three different ways you can install **Binario**:
+
+- **A**. [Git submodule (**Recommended**)](#step-1a-git-submodule-recommended)
+- **B**. [Git clone](#step-1b-git-clone)
+- **C**. [Download ZIP and manual install](#step-1c-download-zip-and-manual-install)
+
+*For more information read the [Install and Use Themes](https://gohugo.io/themes/installing-and-using-themes/)*
+
+### 1A. Git submodule (Recommended)
+
+In your Hugo site directory, run:
+
+```
+$ git submodule add https://github.com/vimux/binario themes/binario
+```
+
+Next, edit your `config.toml` configuration file and add parameter:
+
+```
+theme = "binario"
+```
+
+*You can [read the GitHub documentation for submodules](https://github.com/blog/2104-working-with-submodules) or those found on [Git's website](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for more information*
+
+### 1B. Git clone
+
+In your Hugo site directory, run:
+
+```
+$ git clone https://github.com/vimux/binario themes/binario
+```
+
+Next, edit your `config.toml` configuration file and add parameter:
+
+```
+theme = "binario"
+```
+
+### 1C. Download ZIP and manual install
+
+[Download ZIP](https://github.com/vimux/binario/archive/master.zip) and extract to the `themes/binario`
+
+Next, edit your `config.toml` configuration file and add parameter:
+
+```
+theme = "binario"
+```
+
## Configuration
### Config.toml example