zwbetz-gh / cupper-hugo-theme

An accessibility-friendly Hugo theme, ported from the original Cupper project.
https://cupper-hugo-theme.netlify.app/
MIT License
301 stars 190 forks source link

Installation Instructions clarification #1

Closed mojoa closed 5 years ago

mojoa commented 5 years ago

This may need some clarification. Most of the themes use git clone, not sure why your install is different. https://github.com/gohugoio/hugoThemes#installing-a-single-theme

Installation From the root of your site:

git submodule add https://github.com/zwbetz-gh/cupper-hugo-theme.git themes/cupper-hugo-theme

Results in: $ git submodule add https://github.com/zwbetz-gh/cupper-hugo-theme.git themes/cupper-hugo-theme fatal: not a git repository (or any of the parent directories): .git $

zwbetz-gh commented 5 years ago

Users are free to install the theme however they wish. A regular git clone will work just fine.

I included steps to add it as a git submodule since this is the best way, in my opinion, to install themes when your site will be hosted somewhere like Netlify.

And you got that error because your site was not initialized as as git repo. You need to run git init in your site first, then run the command to add the theme as a submodule.

mojoa commented 5 years ago

OK Thanks!