probberechts / hexo-theme-cactus

:cactus: A responsive, clean and simple theme for Hexo.
https://probberechts.github.io/hexo-theme-cactus/
MIT License
3.15k stars 784 forks source link

Improve readme description #305

Closed metters closed 2 years ago

metters commented 2 years ago

I am new to hexo, so I had problems setting up the template for the first time. After reading the description of another hexo template I realized, the description of the installation process omitted two steps, which i added with https://github.com/probberechts/hexo-theme-cactus/commit/6d2dc29671123f22dac3a9569306da6e53aca7c0

I also fixed some minor typos and unified the formatting.

metters commented 2 years ago

Migrating my own blog to your template (trying this without loosing my current git history), I realised why those first steps were omitted: The description was for people who already use hexo and just want to add cactus as theme by cloning it into their already set up blog folder.

If you wish, I can update the section to cover both cases or at least mention what I just described. For example, something like: If you have not set up a blog yet or are not using hexo yet... else just clone the theme by executing....

probberechts commented 2 years ago

I like your suggestion of adding a "prerequisites" section. I would just move the part about setting up a new blog over there as well. Everything else looks good.

metters commented 2 years ago

I will take care of it in a few days.