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

docs(dsp): fixed readme links #404

Merged
merged 1 commit into from
Aug 7, 2023
Merged

Conversation

Mike-Dax
Copy link
Contributor

@Mike-Dax Mike-Dax commented Aug 7, 2023

Just fixes a couple incorrect links in the README.

@postspectacular
Copy link
Member

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:

<!-- This file is generated - DO NOT EDIT! -->

..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 added a commit that referenced this pull request Aug 7, 2023
- add link to note about editing readme files
@postspectacular postspectacular merged commit 749cd24 into thi-ng:develop Aug 7, 2023
@postspectacular
Copy link
Member

Wow! That was quick! :) thanks again!

@Mike-Dax
Copy link
Contributor Author

Mike-Dax commented Aug 7, 2023

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
Copy link
Member

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!

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

Successfully merging this pull request may close these issues.

2 participants