search

porres / pd-cyclone

A set of Pure Data objects cloned from Max/MSP
BSD 3-Clause "New" or "Revised" License
206 stars 25 forks source link

README.pdf is outdated #626

Closed umlaeute closed 1 year ago

umlaeute commented 1 year ago

the README.pdf appears to be just generated from the README.md so in the strict "source code" sense, there's no need to track both files: the markdown file would be sufficient. you could generate the pdf during build (if you want to include it in the deken packages) or in some separate github action (if you want it to appear as a web resource).

in any case, what's more worrying is that the README.pdf is currently outdated.

commit source displayed version
master README.md 0.7-1
master README.pdf 0.6-1
cyclone_0.7-0 README.md 0.7
cyclone_0.7-0 README.pdf 0.6-1

(I see you've updated the README.md a couple of hours ago, and left out the README.pdf; that's probably intentional (I personally wouldn't want to update generated files whenever i change the sources - that's a task for the computer; but then, I try to avoid tracking any generated files in the first place :wink: ). However I'm pretty sure that the 0.6-1 README.pdf in the Cyclone 0.7-0 release is unintentional.)

porres commented 1 year ago

yeah, when working on the readme I realized I shipped it wrong last time :( will try to make an update soon to fix this

umlaeute commented 1 year ago

i would prefer it if the README.pdf was removed entirely from the repository, so it's obvious which one holds the correct information. (and build the pdf in a github action).

just me 2¢ (with my Debian hat on)

porres commented 1 year ago

closing in favor of https://github.com/porres/pd-cyclone/issues/629