martyna
/
hswro_org
forked from fleg/hswro_org
1
0
Fork 0
Code Pull Requests Activity

update readme

This commit is contained in:
Robert Austin 2021-03-09 16:50:31 +10:00
parent 001afb9ee1
commit 2271fdc351
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -57,25 +57,32 @@ bundle exec jekyll build
# Deployment
## Stackbit
Use Stackbit to deploy this theme. This theme contains a valid and tested `stackbit.yaml`
[![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/zerostaticthemes/jekyll-serif-theme)
## Netlify
This theme contains a `netlify.toml` and has been tested to work with Netlify.
Use Netlify to deploy this theme. This theme contains a valid and tested `netlify.toml` - Feel free to use the 1-click deploy below.
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/zerostaticthemes/jekyll-serif-theme)
## Github Pages
This theme has been tested to work with Github Pages (and Github Project Pages)
If you are using this theme with Github Pages and you are using a Github Project Page then you will need to update the `baseurl` in the `_config.yml` otherwise all the css, images and paths will be broken.
This theme has been tested to work with Github Pages (and Github Project Pages). When using Github Pages you will need to update the `baseurl` in the `_config.yml` otherwise all the css, images and paths will be broken.
For example the site https://zerostaticthemes.github.io/jekyll-serif-theme would have `baseurl: "/jekyll-serif-theme/"`
# Other
## Credits
- Beautiful royalty free Illustrations by Icons8 - https://icons8.com/illustrations/style--pixeltrue
## License
This theme is open source under the MIT license. If you fork or copy this theme you must leave me as the original author in the LICENSE file (on line 3 where I am listed as the author). Really, I just don't want people copying this theme and then saying it's their theme, because I put a lot of work into my themes, thanks!
This theme is open source under the MIT license. Please be respectful 🙏🏽
* If you fork or copy this theme please leave me as an original author in the LICENSE file on line 3 where I am listed as the author.
* Please don't create ports of this theme without at least asking me. Yes this theme is open-source but I've had several people "port" this theme (with only minor changes) and then advertise the theme as their own. Then they don't update it and it starts to get old and break etc. Now lots of people are finding these old crappy versions of the theme.