diff --git a/README.md b/README.md index 11a456ca..d0a4d375 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,7 @@ -# hugoBasicExample +# hugo-paperMod Example -This repository offers an example site for [Hugo](https://gohugo.io/) and also it provides the default content for demos hosted on the [Hugo Themes Showcase](https://themes.gohugo.io/). +This repository offers an example site for [hugo-PaperMod](https://github.com/adityatelange/hugo-PaperMod) -# Using +## Install -1. [Install Hugo](https://gohugo.io/overview/installing/) -2. Clone this repository - -```bash -git clone https://github.com/gohugoio/hugoBasicExample.git -cd hugoBasicExample -``` - -3. Clone the repository you want to test. If you want to test all Hugo Themes then follow the instructions provided [here](https://github.com/gohugoio/hugoThemes#installing-all-themes) - -4. Run Hugo and select the theme of your choosing - -```bash -hugo server -t YOURTHEME -``` - -5. Under `/content/` this repository contains the following: - -- A section called `/post/` with sample markdown content -- A headless bundle called `homepage` that you may want to use for single page applications. You can find instructions about headless bundles over [here](https://gohugo.io/content-management/page-bundles/#headless-bundle) -- An `about.md` that is intended to provide the `/about/` page for a theme demo - -6. If you intend to build a theme that does not fit in the content structure provided in this repository, then you are still more than welcome to submit it for review at the [Hugo Themes](https://github.com/gohugoio/hugoThemes/issues) respository +Read Wiki => [hugo-PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation) \ No newline at end of file