Pitayan / gatsby-theme-pitayan

A minimal blog theme plugin for Gatsby
https://pitayan.github.io/gatsby-theme-pitayan/
MIT License
30 stars 11 forks source link

Updated readme with install instructions #42

Closed remiks closed 1 year ago

remiks commented 1 year ago

Added some more install instructions. Make sense?

Signed-off-by: remi.vandemir remi.vandemir@amesto.no

daiyanze commented 1 year ago

I think a repo contributor would like to use it this way. Usually, a user can start the development from a barebone repo by adding up minimum packages. If we recommend users downloading the repo, they'll also receive "devDependencies" packages after installation.

Maybe we could provide a template repo or npx command to help generate empty blog from start. Or simply add a quick start section in the README.md

remiks commented 1 year ago

aha. I understand. What im trying to figure out is how to do an upgrade with the changes youre doing to the theme in an easy manner.. Right now its a bit confusing.. Any ideas?

daiyanze commented 1 year ago

I see... You meant to have a doc for our repo contributors? I think for the end users, they just need to install the package instead of downloading the whole repo.

Even with the earlier issue of the upgrade you encountered, the published npm package itself won't put those users who started from an empty repo into the situation similar to yours. (The upgrade manual is located in the release page https://github.com/Pitayan/gatsby-theme-pitayan/releases/tag/v0.5.0)

Instead, I think we could put your description under a different section in README.md to help those who want to give this theme a try locally.

remiks commented 1 year ago

Sure, we can use the description I made for contributors and not end users.

BUT. Im really struggling to do an upgrade in our repo. You are welcome to do a fork and try: https://github.com/amestofortytwo/blog

remiks commented 1 year ago

Seems like I got it to build now here: https://github.com/remiks/amestofortywo-blog/tree/update-to-theme-v0.5.0