search

JuliaPluto / computational-thinking-template

Template to build a course webpage like the *Introduction to computational thinking with Julia* course tought at MIT
http://juliapluto.github.io/computational-thinking-template/
Other
32 stars 3 forks source link

Instructions in `README.md` on how to get people started #22

Closed navidcy closed 2 months ago

navidcy commented 2 months ago

So I can clone... but how can I build the website locally so I can start making changes and see their effect?

Could we 1-2 step-instructions in README? I can do it of course (when I figure it out)... :)

lucaferranti commented 2 months ago

Totally agree!

The template itself is the documentation, so there are some more details here: https://juliapluto.github.io/computational-thinking-template/

I fully agree that we should have a TL;DR on the README. I would maybe address this after #20 though, which should simplify the workflow quite a bit

navidcy commented 2 months ago

The template itself is the documentation, so there are some more details here: https://juliapluto.github.io/computational-thinking-template/

Oh I see! I just noticed this..! Then perhaps just add in the README something like

Go to template website :balloon:
template includes instructions for how to start editing to shape to your own needs