Skip to content

Improve README.md to ease the onboarding process for newcomers. #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
costacoz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve README.md to ease the onboarding process for newcomers. #367

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,19 @@ $ cd themes
$ git clone https://github.com/devcows/hugo-universal-theme
```

To make first successful launch perform these steps:

* After the theme cloned open `{site_root}\themes\hugo-universal-theme\exampleSite` folder.
* Copy `content`, `data`, `static` and `config.toml` to your `{site_root}` folder. Replace files, if necessary.
* Then open `config.toml` and remove: `themesDir = "../.."` line.

Now you can launch the project locally using: `hugo server -D`.

To launch it on the server change the `baseurl` in `config.toml` file to a URL that your site will be served from, like so:
```
baseurl = "https://<username>.github.io/hugo-universal-theme/"
```

For more information read the official [setup guide](https://gohugo.io/overview/installing/) of Hugo.


Expand Down