Init 1

README.md

@@ -0,0 +1,73 @@
+# Hello Friend
+
+This theme was made to help you present your ideas easier. We all know how hard is to start something on the web, especially these days. You need to prepare a bunch of stuff, configure them and when that’s done — create the content.
+
+This theme is pretty basic and covers all of the essentials. All you have to do is start typing!
+
+## Features
+
+- **light/dark mode**, depending on your preferences
+- great reading experience thanks to [**Inter UI font**](https://rsms.me/inter/), made by [Rasmus Andersson](https://rsms.me/about/)
+- nice code highlighting thanks to [**PrismJS**](https://prismjs.com)
+- an easy way to modify the theme (**Webpack, NodeJS, PostCSS** — initial setup created by [Marcin Dziewulski](http://www.mobily.pl))
+- fully responsive
+
+## How to start
+
+You can download the theme manually by going to [https://gitlab.com/panr/hugo-theme-hello-friend](https://gitlab.com/panr/hugo-theme-hello-friend) and pasting it to `themes/hello-friend` in your root directory.
+
+You can also clone it directly to your Hugo folder:
+
+```
+$ git clone https://gitlab.com/panr/hugo-theme-hello-friend themes/hello-friend
+```
+
+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. To do so, include it as a git submodule:
+
+```
+$ git submodule add https://gitlab.com/panr/hugo-theme-hello-friend themes/hello-friend
+```
+
+## How to configure
+
+The theme doesn't require any advanced configuration. Just copy `config.toml` file from `exampleSite` directory to your Hugo root directory and change params fields.
+
+## How to run your site
+
+From your Hugo root directory run:
+
+```
+$ hugo server -t hello-friend
+```
+
+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 edit the theme
+
+If you really want to edit the theme, you need to install Node dependencies. To do this, go to the theme directory (from your Hugo root directory):
+
+```
+$ cd themes/hello-friend
+```
+
+and then run:
+
+```
+$ npm install
+$ npm i yarn
+$ yarn
+```
+
+## How to contribute
+
+If you spot any bugs, please use [Issue Tracker](https://gitlab.com/panr/hugo-theme-hello-friend/issues) or if you want to add a new feature directly please create a new [Pull/Merge Request](https://gitlab.com/panr/hugo-theme-hello-friend/merge_requests).
+
+## Licence
+
+Copyright © 2018 Radosław Kozieł ([@panr](https://twitter.com/panr))
+
+The theme is released under the MIT License. Check the [original theme license](https://gitlab.com/panr/hugo-theme-hello-friend/blob/master/LICENSE.md) for additional licensing information.
+
+
+
+