From d8036a9993fe3a715851c16b1da78e1fa9edcd2d Mon Sep 17 00:00:00 2001 From: Djordje Atlialp Date: Sun, 27 Jan 2019 23:17:21 +0100 Subject: [PATCH] Edit README.md --- README.md | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 173d30f..63377da 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # Hello Friend -![Hello Friend](https://github.com/panr/hugo-theme-hello-friend/blob/master/images/screenshot.png?raw=true) +![Hello Friend NG](https://github.com/rhazdon/hugo-theme-hello-friend-ng/) 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! -### DEMO - https://hugo-hello-friend.now.sh/ ## Features @@ -37,18 +36,18 @@ By default the theme is using PrismJS to color your code syntax. All you need to ## How to start -You can download the theme manually by going to [https://github.com/panr/hugo-theme-hello-friend.git](https://github.com/panr/hugo-theme-hello-friend.git) and pasting it to `themes/hello-friend` in your root directory. +You can download the theme manually by going to [https://github.com/rhazdon/hugo-theme-hello-friend-ng.git](https://github.com/rhazdon/hugo-theme-hello-friend-ng.git) and pasting it to `themes/hello-friend-ng` in your root directory. You can also clone it directly to your Hugo folder: ``` -$ git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend +$ git clone https://github.com/rhazdon/hugo-theme-hello-friend-ng.git themes/hello-friend-ng ``` 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://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend +$ git submodule add https://github.com/rhazdon/hugo-theme-hello-friend-ng.git themes/hello-friend-ng ``` ## How to configure @@ -58,7 +57,7 @@ The theme doesn't require any advanced configuration. Just copy: ``` baseurl = "/" languageCode = "en-us" -theme = "hello-friend" +theme = "hello-friend-ng" paginate = 5 [params] @@ -69,16 +68,14 @@ paginate = 5 [languages] [languages.en] - title = "Hello Friend" + title = "Hello Friend NG" subtitle = "A simple theme for Hugo" keywords = "" copyright = "" - writtenBy = "Written by" - readMore = "Read more" readOtherPosts = "Read other posts" [languages.en.params.logo] - logoText = "hello friend" + logoText = "hello friend ng" logoHomeLink = "/" # or # @@ -96,14 +93,13 @@ paginate = 5 url = "/showcase" ``` -to `config.toml` file in your Hugo root directory and change params fields. In case you need, here's [a YAML version](https://gist.github.com/panr/8f9b363e358aaa33f6d353c77feee959). ## How to run your site From your Hugo root directory run: ``` -$ hugo server -t hello-friend +$ hugo server -t hello-friend-ng ``` 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. @@ -113,20 +109,18 @@ and go to `localhost:1313` in your browser. From now on all the changes you make 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 +$ cd themes/hello-friend-ng ``` and then run: ``` $ npm install -$ npm i yarn -$ yarn ``` ## How to contribute -If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-theme-hello-friend/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/panr/hugo-theme-hello-friend/pulls). +If you spot any bugs, please use [Issue Tracker](https://github.com/rhazdon/hugo-theme-hello-friend-ng/issues) or if you want to add a new feature directly please create a new [Pull Request](https://github.com/panr/hugo-theme-hello-friend/pulls). ## Licence