search

thi-ng / umbrella

⛱ Broadly scoped ecosystem & mono-repository of 199 TypeScript projects (and ~180 examples) for general purpose, functional, data driven development
https://thi.ng
Apache License 2.0
3.35k stars 149 forks source link

docs(dsp): fixed readme links #404

Closed Mike-Dax closed 1 year ago

Mike-Dax commented 1 year ago

Just fixes a couple incorrect links in the README.

postspectacular commented 1 year ago

Hi @Mike-Dax - thank you - alas any changes to readme's in this repo should be done to the tpl.readme.md files, since all the README.md docs are generated. See:

https://github.com/thi-ng/umbrella/blob/74518d1017852c1a4d2f0e749f8f0f2cb9123995/packages/dsp/README.md?plain=1#L1

..and here:

https://github.com/thi-ng/umbrella/blob/develop/CONTRIBUTING.md#changes-to-readme-files

Pls let me know if you're ok to change this, else can also do it myself... 🙏

postspectacular commented 1 year ago

Wow! That was quick! :) thanks again!

Mike-Dax commented 1 year ago

Ah sorry, I thought I did that correctly but it seems the build script didn't generate the actual README.md correctly, erroring with the below:

shasum: ../../assets/banners/thing-dsp.svg: No such file or directory
Command failed: shasum ../../assets/banners/thing-dsp.svg
shasum: ../../assets/banners/thing-dsp.svg: No such file or directory

Shows me for trying to make a quick change and not reading properly. I'm struggling to find documentation for generating those banner assets so the README build doesn't error?

postspectacular commented 1 year ago

It's ok, don't worry - I just realized that banner issue too - only works if you've got the thi.ng/fontgen built and generated the banners. Will do it myself, since also using this opportunity to do a few other edits in that DSP readme... thanks again!