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

Better READMEs #6

Open
3 of 4 tasks
fingolfin opened this issue Nov 22, 2021 · 0 comments
Open
3 of 4 tasks

Better READMEs #6

fingolfin opened this issue Nov 22, 2021 · 0 comments

Comments

@fingolfin
Copy link
Member

fingolfin commented Nov 22, 2021

  • The generated READMEs should describe how to load one of the packages. I.e.
    julia> using GAP_pkg_foobar ; GAP_pkg_foobar.load() 
    
  • They should also point back at this repository here.
  • they should point out the license, and that it may differ from that of the GAP packages
  • in fact perhaps mention the GAP package license, at least by quoting the pkginfo.License field, if present (in which case it contains an SPDX ID)
  • ...

Other information that should be included?

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