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

github.com/cowboysmall-tools/hugo-business-frontpage-theme.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.md138
1 files changed, 136 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3d0ea39..fb3a077 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,136 @@
-# hugo-business-frontpage-theme
-Business Frontpage is a basic HTML starter template for creating a Bootstrap based website for a small business or other organization.
+# Hugo Business Frontpage Theme
+
+This is a Hugo port of [Business Frontpage](//github.com/BlackrockDigital/startbootstrap-business-frontpage) - a basic HTML starter
+template for creating a Bootstrap based website for a small business or other organization.
+
+
+
+
+
+
+## Screenshot
+
+![Business Frontpage screenshot](https://raw.githubusercontent.com/cowboysmall-tools/hugo-business-frontpage-theme/master/images/screenshot.png)
+
+
+
+
+
+
+## Features
+
+### Original
+
+- Responsive
+- HTML5 + CSS3
+- Bootstrap 4
+- Full width image header with text overlay
+- Fixed top navigation menu
+- Call to action boxes
+- Three column marketing boxes with images
+
+### Added
+
+- Google Analytics
+
+
+
+
+
+
+<!--
+## Demo
+
+You can see it in action on [Hugo Themes site](http://themes.gohugo.io/theme/hugo-business-frontpage-theme/).
+-->
+
+
+
+
+
+
+## Contents
+
+- [Installation](#installation)
+- [Getting started](#getting-started)
+ - [Setup](#setup)
+ - [Viewing](#viewing)
+ - [Building](#building)
+- [Contributing](#contributing)
+- [License](#license)
+
+
+
+
+
+
+
+## Installation
+
+Within the root of your Hugo project execute the following:
+
+ $ cd themes
+ $ git clone https://github.com/cowboysmall-tools/hugo-business-frontpage-theme.git
+
+
+
+
+
+
+
+
+
+## Getting Started
+
+After successful installation as a minimum you need to take the following steps:
+
+### Setup
+
+Go to [`exampleSite`](//github.com/cowboysmall-tools/hugo-business-frontpage-theme/tree/master/exampleSite) and copy
+[`config.toml`](//github.com/cowboysmall-tools/hugo-business-frontpage-theme/blob/master/exampleSite/config.toml)
+to the root of your site. Open `config.toml` and add your relevant information.
+
+### Viewing
+
+To view your site, execute the following:
+
+ $ hugo server -D
+
+and go to `localhost:1313` in your browser.
+
+### Building
+
+To generate your site in the `public` folder, execute the following:
+
+ $ hugo
+
+within the root of your project.
+
+
+
+
+
+
+
+## Contributing
+
+Post bugs and contributions to the [issue tracker](//github.com/cowboysmall-tools/hugo-business-frontpage-theme/issues).
+Or make a [pull request](//github.com/cowboysmall-tools/hugo-business-frontpage-theme/pulls).
+
+
+
+
+
+
+
+## License
+
+The original Business Frontpage template is copyright 2013-2019 [Blackrock Digital](http://blackrockdigital.io/) LLC. Code
+released under the [MIT](https://github.com/BlackrockDigital/startbootstrap-business-frontpage/blob/gh-pages/LICENSE)
+license.
+
+You may change the "Copyright..." line by adding the following to the end of `config.toml`
+
+ [params.footer]
+ copyright = ""
+