mozilla / mp4parse-rust

Parser for ISO Base Media Format aka video/mp4 written in Rust.
Mozilla Public License 2.0
404 stars 62 forks source link

Adding build instructions for mp4parse-rust ? #411

Open abdullahfarwees opened 1 year ago

abdullahfarwees commented 1 year ago

I've been exploring the mp4parse-rust repository and have been interested in contributing. While I'm enthusiastic about getting involved, I noticed that there are no build instructions provided in the repository. As a newcomer, I found this a bit challenging as I tried to set up the project environment. I believe that adding clear build instructions could greatly benefit both newcomers and existing contributors. Not only would it save time and frustration, but it would also encourage more people to engage with the project.

I'm willing to contribute to this effort by drafting the build instructions or assisting in any way I can. What do you think about adding build instructions to the repository? Your guidance on the preferred format or any specific requirements for the instructions would be greatly appreciated.

Thank you for your time, and I look forward to your feedback.

kinetiknz commented 1 year ago

Thanks for your feedback. Adding clear build instructions would be useful - I think adding a build section to the top level README.md makes sense. This could also address #412 by mentioning the requirement to run git submodule update --init before running cargo test.