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

[UX] Integrate and update example files to serve as practical references #1560

Open
HugoGenillier opened this issue Aug 7, 2024 · 3 comments

Comments

@HugoGenillier
Copy link
Contributor

Example files can be very powerfull to guide new users, unfortunately they are currently hard to access and some of them are outdated.

It would be great to provide other ways to access these example files (they are only available from the start screen, on a GitHub repository). The GitHub repository slows down users and can dissuade them to fetch these files, it's worth considering integrating them into score. These example files should also be mentioned in the documentation, in the get started part for instance.

Some files are not compatible anymore with latests versions and cannot longer be used. The already a strong basis of examples needs to be updated and commented. Having an example file for each use case is the way to go. We want users to be able to quickly and easily find an example of what they want to do, and build their score around it.

This recommandation was judged as very impactfull.

image
The "osc" example files is a great one with comments and reusable elements.

@jcelerier
Copy link
Member

@HugoGenillier could you go through the examples and mark the one that fails ? I'll fix them first :)

@HugoGenillier
Copy link
Contributor Author

Here is the list (tested on score 3.2.4, windows) :

  • example-device.device : i don't really know how to use .device files, cannot check if it works
  • faust-melodies.score : crashes when it comes to the "Buzz" part and i don't hear anything (but maybe it's my config)
  • lygia-filter.score : crashes on play
  • lygia-tutorial.score : the window remains black for me

But some other crashed during interviews like video-colorizing.score on a mac.
Also some examples requires to download media files to make them work, it might confuse users or discourage them if they have to download manually.

Also there are some files .pd, .frag of .device that works when you drag them in ossia but some users will find it unclear and won't really know how to load the example.

@jcelerier
Copy link
Member

thanks ! the lygia ones require an additional library installed through the package manager, maybe that's something to add a detection step for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants