typst-community / typst-package-template

The Unlicense
3 stars 2 forks source link

Do not exclude README.md #12

Closed jneug closed 1 week ago

jneug commented 1 week ago

I just got a comment on a package I initialized with this template that README.md should not be excluded. I guess the same goes for CHANGELOG.md.

SillyFreak commented 1 week ago

https://github.com/typst/packages/pull/747 for reference

README.md should in principle be enough for packaging for Universe. The reasons for not excluding something as I understand them are basically

Some other files are part of the PR but still excluded: you want working links to those on the Universe page, but it's not necessary for Typst to download them when they are imported. Manuals and documentation assets are classic examples.

I think CHANGELOG.md falls more in the "exclude this" category, but it's relatively useful to have locally for its size, so it's probably worth including it too.

If there's no other opinions on this, I'll make this change sometime today.