feature: add development instructions

[alexvoss]

A first draft of instructions for setting up a development environment (as requested in #82).

I am aware of scripts/dev.py but this does not quite work in this case as it does not cover the case where someone wants to work on the themes. So, I created manual instructions instead. They are not overly complicated, I think.

Also, I tried building the UI while zensical serve was running and it does watch the theme directory but crashes with a file not found error. Not sure if it would be possible to fix that. Might mean doing a re-try on error or there would need to be a way to tell Zensical that the theme is just being re-built and that it should wait.

[squidfunk]

LGTM! One final additional might be to explain how to test the build with changes on a local project – you can install it in editable mode and make changes as you go. That's how development looks for me from day to day.

So in a project of your choice, just do:

pip install -e /path/to/zensical/sources

Maybe you have a better idea for the folder placeholder, it's the folder the user cloned and build Zensical in.

[pawamoy]

Nice! I'd also explicitly set the shell or bash language to relevant code blocks, though I'm not sure this is done consistently through the docs already so, not very important 🙂

[alexvoss]

Nice! I'd also explicitly set the shell or bash language to relevant code blocks, though I'm not sure this is done consistently through the docs already so, not very important 🙂

I tried various combinations and never got highlighting that made any sense (IMHO). bash and shell never annotated anything and bat and powershell only highlight built-in commands, so the call to Git does not get highlighted and it looks just weird (again, IMHO). Maybe one day we'll have a better solution?

[pawamoy]

Ah yeah, I agree, highlighting on short shell commands is never that great.