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

adds proper description to my script collection #152

Merged
merged 1 commit into from
Sep 5, 2024
Merged

adds proper description to my script collection #152

merged 1 commit into from
Sep 5, 2024

Conversation

jansindl3r
Copy link
Contributor

sorry for the extra PR

@florianpircher florianpircher merged commit b0cf7ba into schriftgestalt:glyphs3 Sep 5, 2024
1 check passed
@florianpircher
Copy link
Collaborator

All good! I think we want to automate this kind of list more and more so that you don’t have to keep the description up to date with the scripts. You can see an automatic index of all scripts here:

https://florianpircher.com/glyphs/scripts-index/

Move and hold your mouse pointer over a script name to see its description, if it has any.

@jansindl3r
Copy link
Contributor Author

jansindl3r commented Sep 5, 2024

That's a good idea! I also have it automated for my descriptions

https://raw.githubusercontent.com/jansindl3r/Glyphs-Scripts/main/make_readme.py

now I found out the folder title is not indented as i intended, which requires another PR, which must be a bit annoying for you, so having it automated would be great! Or having the possibility for users to link to raw readme? I imagine one might want longer __doc__ when hovering above a script in Glyphs and shorter "readme" for plugin manager.

I think RoboFont extensions work similar way that the description is not hardcoded

Ah cool that's a cool website!

@florianpircher
Copy link
Collaborator

florianpircher commented Sep 5, 2024

I think the description in the package index should just be a short description about your scripts collection, not about the scripts themselves. Then, in the future, Glyphs will present the description plus a similarly, automatically generated list as the website does. For now, keeping a list of scripts in the description is fine.


now I found out the folder title is not indented as i intended, which requires another PR

You don’t need to send a PR here for that. Just update your repository and it will get reflected.

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