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

Polishing Setup Instructions. #4

Open
4 tasks
ndaelman-hu opened this issue Jul 6, 2024 · 1 comment
Open
4 tasks

Polishing Setup Instructions. #4

ndaelman-hu opened this issue Jul 6, 2024 · 1 comment
Assignees

Comments

@ndaelman-hu
Copy link

While preparing Tutorial 14, I noticed some small points that could further remove friction when setting up:

  • Mention that cruft is a python package that should be installed. This is especially for those using cruft for the 1st time.
  • Suggest people to go with Apache 2.0 license (so it is most compatible with the NOMAD license). Maybe also make it the default option.
  • Give specifications on what should happen with the README.md, i.e. should it stay untouched, or may it be updated to reflect the objective of the plugin, as most README's do. My assumption is that the docs and entry point metadata rather serve these respective goals. Still best to be very clear here.
  • Point out where the “Use this template” button.
@blueraft
Copy link
Collaborator

Sorry, I didn't see this earlier. I'll have a look

@blueraft blueraft self-assigned this Aug 13, 2024
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

2 participants