Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
navidcy opened this issue Jul 11, 2024 · 2 comments · Fixed by #23
Closed

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

navidcy opened this issue Jul 11, 2024 · 2 comments · Fixed by #23

Comments

@navidcy
Copy link
Contributor

navidcy commented Jul 11, 2024

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
Copy link
Member

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
Copy link
Contributor Author

navidcy commented Jul 11, 2024

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 🎈
template includes instructions for how to start editing to shape to your own needs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants