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

github.com/miguelsimoni/hugo-initio.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Simoni <miguel.simoni@gmail.com>2017-10-10 04:01:27 +0300
committerMiguel Simoni <miguel.simoni@gmail.com>2017-10-10 04:01:27 +0300
commit8dfeceb5887aa68c2e10e3aef90c36b17a89d880 (patch)
tree49d208e3ea88c605b5613da824cdb31ce0ce2d05 /README.md
parent5a9ed72e4b246a202265b849c4e9f0cc8af34569 (diff)
updated: readme file, footer template. added example site.
Diffstat (limited to 'README.md')
-rw-r--r--README.md111
1 files changed, 109 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2fa5f74..f34e8ae 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,110 @@
-# hugo-initio
+# Initio theme for Hugo
-Hugo Theme adaptation of the Initio template from gettemplate.com
+[Hugo-Initio](https://miguelsimoni.github.io/hugo-initio-site/) is ported from the [Initio](http://www.gettemplate.com/info/initio/) template by [GetTemplate.com](http://www.gettemplate.com/) for [Hugo](https://gohugo.io/).
+
+![screenshot](https://raw.githubusercontent.com/miguelsimoni/hugo-initio/master/images/tn.png)
+
+### Original Template Info
+
+**Licensing:** Creative Commons (for more options, go to the [original template site](http://www.gettemplate.com/info/initio/))
+**Released:** Feb 21, 2014
+**Last Updated:** Feb 21, 2014
+**Version:** 1.0
+**Bootstrap:** 3.3.4 or higher
+**Libraries:** jQuery
+**Designer:** Sergey Pozhilov
+
+## Installation
+
+```
+$ cd /<your-hugo-site-directory>
+$ mkdir themes
+$ cd themes
+$ git clone --depth=1 https://github.com/miguelsimoni/hugo-initio.git
+$ rm -rf hugo-initio/.git
+```
+
+More info: [hugo setup guide](https://gohugo.io/overview/installing/)
+
+## Configuration
+
+[Example Site](https://github.com/miguelsimoni/hugo-initio/tree/master/exampleSite)
+
+[config.toml](https://github.com/miguelsimoni/hugo-initio/tree/master/exampleSite/config.toml)
+
+### Sections
+
+
+```toml
+showSubheader = true
+showServices = true
+showRecentWorks = true
+showDownload = true
+showClients = true
+```
+### Social Networks Icons
+
+You can add as many social networks as you want in the params.social array following this template:
+
+```toml
+[[params.social]]
+ title = "facebook"
+ url = "https://www.facebook.com/nickname"
+ icon = "fa-facebook-square"
+ footer = true
+ sharethis = true
+ network = "facebook"
+```
+
+See the whole configuration in the [config.toml](https://github.com/miguelsimoni/hugo-initio/tree/master/exampleSite/config.toml) file.
+
+### Comments
+
+Powered by [Disqus](https://disqus.com)
+
+```toml
+[params.disqus]
+ site = "your-disqus-short-name"
+```
+
+Disable the comments system by leaving the `params.disqus.site` empty.
+
+### Google Analytics
+
+```toml
+[params.google.analytics]
+ trackerID = "GA-000000000-0"
+```
+
+Disable the Google Analytics by leaving `params.google.analytics.trackerID` empty.
+
+### Almost there...
+
+In order to see your site in action, you can run Hugo's built-in local server.
+
+```
+$ hugo server
+```
+
+Now enter [`http://localhost:1313/hugo-initio-site/`](http://localhost:1313/hugo-initio-site/) in the address bar of your browser.
+
+## Deployment
+
+- [Hosting on GitHub](https://gohugo.io/hosting-and-deployment/hosting-on-github/)
+- [More hosting and deployment options](https://gohugo.io/hosting-and-deployment/)
+
+## Contributing
+
+- Found a bug?
+- Got an idea for a new feature?
+
+Let me know it using the [issue tracker](https://github.com/miguelsimoni/hugo-initio/issues).
+Or make it directly: [pull request](https://github.com/miguelsimoni/hugo-initio/pulls).
+
+## License
+
+This port is released under the MIT License. Check the [original theme license](http://www.gettemplate.com/info/initio/) for additional licensing information.
+
+## Thanks
+
+Thanks to [Steve Francia](https://github.com/spf13) for creating Hugo and the awesome community around the project. And also thanks to [Sergey Pozhilov](http://www.gettemplate.com/) for creating this awesome theme.