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

10x better readme #112

Open
fulldecent opened this issue Nov 26, 2024 · 0 comments
Open

10x better readme #112

fulldecent opened this issue Nov 26, 2024 · 0 comments

Comments

@fulldecent
Copy link
Owner

fulldecent commented Nov 26, 2024

And a SLIGHTLY better built site.


Here is a good example of a template project readme:

https://github.com/fulldecent/moodle-local_plugin_template

Document the assumptions we made here, and which best practices we chose. (Maybe this is already done in an older version of README.md?)


Explain why we choose to use the GitHub Pages gem version of Jekyll instead of the latest available (and much better!) version.

It is because many people are already using GitHub Pages with the default settings. And therefore this template project will be a great drop-in starting point for them.

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

No branches or pull requests

1 participant