-
Notifications
You must be signed in to change notification settings - Fork 2
draft text for project goals, please comment #3
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
Conversation
Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
goals.md
Outdated
| - combining the best ideas and code from existing projects. | ||
|
|
||
| # What | ||
| - a crate being a good base: We can implement all the needed use cases with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are the core use cases? Who wants to use audio crates in Rust? Are there key tradeoffs in the space?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes we should have those here. I have some answers to those questions but they are bound to be incorrect. I propose we
- collect all possible use cases. If possible with some user story/context around those. To that end I have added what I know from Rodio.
- document the tradeoffs
- select which to focus on (the core use case).
alice-i-cecile
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally could use a rewrite for grammar / writing quality: ping me when the content is done and I'll be happy to draft something up for you quick.
Very much a draft, I have added everything we currently have & want from the rodio side. Since I know little of what Kira and Firewheel provide or what Bevy needs (ECS what is that dark magic?!) I left that TODO.
|
I think it would be helpful to explain how the Firewheel engine can be used to meet all of these goals. If you don't mind, I would like to write up my own draft text for project goals coming from own perspective. Then we can look into merging our drafts together. |
Good idea, I've added you to the repo feel free to push directly to main or open a PR. Let me know if you need anything. |
|
Alright, I added my own text to the document! |
Update goals.md
While great additions goals was getting quite long. Future changes will reference these sections again. Secondly this change makes it easier to extend those sections in the future.
|
I am still working on incorporating the changes. Looking back project goals as a title was not a good starting point :) |
|
I've moved things around. There is now one short Readme with multiple supporting pieces.
We have a good base now, provided there are no major objections I would like to merge this as is. Further changes would then be new new PR's. |
alice-i-cecile
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No major objections. Bother me for an editing pass before widespread publication but I agree on merging.
reviews might be a good way to discuss this. We can merge it once we largely agree.
For big changes/additions a PR is probably best.