Skip to content

Minor Improvements to the README#417

Merged
boozook merged 2 commits intoboozook:mainfrom
andreascasapu:readme-improvements
Sep 7, 2024
Merged

Minor Improvements to the README#417
boozook merged 2 commits intoboozook:mainfrom
andreascasapu:readme-improvements

Conversation

@andreascasapu
Copy link
Copy Markdown
Contributor

This pull request covers some minor improvements to the README. These consist of:

  • Fixing the playdate-sound example to use the actual example name, sp, instead of the source file name, sp-simple
  • Add the required feature flag to all example commands. When I first ran these locally, compilation failed due to the required features not being met.

The `cargo playdate run` examples in the README referred to `sp-simple`.
However, while the actual file is called `sp-simple.rs`, the example is
called just `sp`. Hence, correct the README with the right name.
When running locally, the `cargo run`/`cargo playdate run` examples in
the README failed to compile due to missing required features. Hence,
add the relevant flag to all examples to ensure that they build and run
correctly, assuming the rest of the pre-requisites have been met.
@github-actions github-actions bot added the docs Improvements or additions to documentation label Sep 4, 2024
@andreascasapu
Copy link
Copy Markdown
Contributor Author

I think your work on making Rust a viable option for Playdate development is awesome, and I wanted to help out 😄

I only just pulled the repo and noticed that the examples in the README didn't quite work, hence me making this request. Please let me know if you have any thoughts or suggestions. I hope that once I become more familiar, I would be able to contribute more to your project (only if you are ok with that, of course).

Thanks again for putting in the work to make this!

@boozook
Copy link
Copy Markdown
Owner

boozook commented Sep 7, 2024

Thank you very much, great find! ❤️‍🔥

I would be able to contribute more to your project

That could be awesome!

@boozook boozook merged commit f62553e into boozook:main Sep 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants