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

github.com/salsysd/hugo-assembly.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index 0c1aec7..432d0c8 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,11 @@
# Assembly Theme
+![](images/screenshot.png)
+
This theme is a Hugo port of the assembly theme by [http://templated.co](http://templated.co). A two-column, fixed-width design with dark color scheme.
+---
-![](images/screenshot.png)
+[![Waffle.io - Columns and their card count](https://badge.waffle.io/salsysd/hugo-assembly.svg?columns=Inbox,In%20Progress,Done)](https://waffle.io/salsysd/hugo-assembly)
## Installation
@@ -16,17 +19,17 @@ $ git clone https://github.com/salsysd/hugo-assembly.git
## Getting started
### The config file
-Take a look inside the exampleSite folder of this theme. You’ll find a file called config.toml. To use it, copy the config.toml in the root folder of your Hugo site. Feel free to change the strings in this theme.
+Take a look inside the `exampleSite` folder of this theme. You’ll find a file called `config.toml`. To use it, copy the `config.toml` in the root folder of your Hugo site. Feel free to change the strings in this theme.
-Add `theme = "hugo-assembly"` to this config or when starting service, use `hugo server -t hugo-assembly`.
+Add `theme = "hugo-assembly"` to this config or when starting the service, use `hugo server -t hugo-assembly`.
## Credits
-Credit for this theme goes fully to [http://templated.co](http://templated.co), which is licensed under a [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license. If you use this Hugo port, please consider the terms of that license and make proper attribution to [http://templated.co](http://templated.co).
+Credit for this theme goes to [http://templated.co](http://templated.co), which is licensed under a [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) license. If you use this Hugo port, please consider the terms of that license and make proper attribution to [http://templated.co](http://templated.co).
## Changelog
- The initial port by @salsysd is [here](changelog.md); if you fork this theme and make changes, please list them in the changelog.
-- fixed minor items for the hugo theme build script
+- fixed minor issues for the hugo theme build script