search

see-mike-out / erie-web

Erie (a declarative grammar for data sonification)
MIT License
4 stars 0 forks source link

adding examples #4

Open sadish-d opened 5 months ago

sadish-d commented 5 months ago

I would find it helpful to have a few examples that directly use erie in the browser (html page + .js file, no downloads from npm). It would make it easier for users to get familiar with the software.

see-mike-out commented 5 months ago

Hi! I'm wondering what you mean more exactly. Could you give me an example? And thank you for suggestions!

sadish-d commented 5 months ago

I've found it helpful when packages document code examples of some of their basic features. I imagine for this package, you could have a folder with a html file, the erie-web.min.js, and maybe some css file. The html file would have some json with all the input needed to create a certain visual/sonification, say a histogram. (Or maybe the json is a file of its own). Then, users can add/edit the json to learn what each setting is doing.

I think some of this we can do in your original paper. But it would be nice to have some stand-alone examples with minimal documentation that users can play around with locally, one file or folder for each type of visual/sonification combination.

curran commented 5 months ago

Where are the working examples? I'd like to try this library, but not sure how to get to "Hello world". Is there something like a line chart with sound that I can try out as a starter template? Thanks!

curran commented 5 months ago

The documentation seems to use Svelte in some examples. Do you have a complete and working Svelte app you could share, that demonstrates how to fit all the pieces together?

This documentation page does not actually show how to use the package to make a sound

https://see-mike-out.github.io/erie-documentation/docs/how-to-use/js-api.html

see-mike-out commented 2 months ago

Where are the working examples? I'd like to try this library, but not sure how to get to "Hello world". Is there something like a line chart with sound that I can try out as a starter template? Thanks!

Visit here for example specs. https://see-mike-out.github.io/erie-editor You could also look at the repo of this gallery to see how it is being imported and used: https://github.com/see-mike-out/erie-editor

see-mike-out commented 2 months ago

Plus, you should be able to use on any JS framework (technically, but haven't been full tested), even with Vanilla JS (I test this from time to time). If you run into any problem with running it on other frameworks, please let me know (preferably with a repo/code).