[HUGO] theme

1 files changed, 76 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f27d63b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# Dimension
+
+A port of HTML5UP's responsive and minimal dimension theme.
+
+![Terminal](./images/screenshot.png)
+
+---
+
+- [Dimension](#dimension)
+  - [How to start](#how-to-start)
+  - [How to configure](#how-to-configure)
+  - [Post archetype](#post-archetype)
+  - [How to run your site](#how-to-run-your-site)
+  - [How to contribute](#how-to-contribute)
+  - [Sponsoring](#sponsoring)
+  - [License](#license)
+
+## How to start
+
+You can download the theme manually by going to [https://github.com/your-identity/hugo-theme-dimension.git](https://github.com/your-identity/hugo-theme-dimension.git) and pasting it to `themes/dimension` in your root directory.
+
+You can also clone it directly to your Hugo folder:
+
+```
+$ git clone https://github.com/your-identity/hugo-theme-dimension.git themes/dimension
+```
+
+If you don't want to make any radical changes, it's the best option, because you can get new updates when they are available. You can also include it as a git submodule:
+
+```
+$ git submodule add https://github.com/your-identity/hugo-theme-dimension.git themes/dimension
+```
+
+## How to configure
+
+The theme doesn't require any advanced configuration. Just copy:
+
+```toml
+baseurl = "/"
+languageCode = "en-us"
+theme = "dimension"
+```
+
+to `config.toml` file in your Hugo root directory and change params fields.
+
+**NOTE:** All the main page styling and configuration can be done by creating `_index.md` pages in the `content` folder and subdirectories. This choice was made to allow the use of any headless CMS (e.g. netlify) for total customization.
+
+## Post archetype
+
+See the basic `_index.md` file params supported by the theme — https://github.com/your-identity/hugo-theme-dimension/blob/master/archetypes/_index.md
+
+## How to run your site
+
+From your Hugo root directory run:
+
+```
+$ hugo server -t dimension
+```
+
+and go to `localhost:1313` in your browser. From now on all the changes you make will go live, so you don't need to refresh your browser every single time.
+
+## How to contribute
+
+If you spot any bugs, please use [Issue Tracker](https://github.com/your-identity/hugo-theme-dimension/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/your-identity/hugo-theme-dimension/pulls).
+
+## Sponsoring
+
+If you like my work and want to support the development of the project, now you can! Just:
+
+<a href="https://www.buymeacoffee.com/dasnaghi" target="_blank"><img src="https://res.cloudinary.com/panr/image/upload/v1579374705/buymeacoffee_y6yvov.svg" alt="Buy Me A Coffee" ></a>
+
+## License
+
+Copyright © 202020 Davide Asnaghi
+
+The theme is released under the MIT License. Check the [original theme license](https://github.com/panr/hugo-theme-terminal/blob/master/LICENSE.md) for additional licensing information.