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

Mention wasm-features in Readme.md #167

Merged

Conversation

Glitchy-Tozier
Copy link
Contributor

When important features aren't mentioned, this can lead to some confusion

Therefore, I suggest quickly mentioning them. :)
This pull-request adds a mention about WebAssembly and the required features.


Eventually, it would be handy to have every existing feature described in the Readme.md. Nothing extensive, just a short mention that the feature exists and an overview of what it does.

Copy link
Member

@stefan-k stefan-k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this PR and apologies for the confusion this has caused!

The reason why this wasn't documented so far is that this feature isn't well tested and not part of the CI (see #89) since I don't need this feature myself and haven't had time yet to get into it in detail. I have suggested minor changes to your PR to reflect that.

If you have experience with compiling to WASM, I would be very very happy if you could add a check to the CI as well :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@stefan-k stefan-k added this to the v0.5.0 milestone Dec 31, 2021
Glitchy-Tozier and others added 3 commits January 1, 2022 16:51
Co-authored-by: Stefan Kroboth <stefan.kroboth@gmail.com>
Co-authored-by: Stefan Kroboth <stefan.kroboth@gmail.com>
Co-authored-by: Stefan Kroboth <stefan.kroboth@gmail.com>
@Glitchy-Tozier
Copy link
Contributor Author

I've implemented the requested changes! :)

If you have experience with compiling to WASM, I would be very very happy if you could add a check to the CI as well :)

I don't have much experience, unfortunately. Maybe @dariogoetz could share his sources with you though. He has set up the infrastructure of our keyboard-project.

@stefan-k
Copy link
Member

stefan-k commented Jan 2, 2022

Thanks for making the changes! I added the same text to src/lib.rs as I typically create the readme from there using cargo readme.

@stefan-k stefan-k merged commit 8bc447f into argmin-rs:master Jan 2, 2022
@Glitchy-Tozier
Copy link
Contributor Author

By the way, I'm just curious: When do you plan on releasing v0.5.0?

@stefan-k
Copy link
Member

stefan-k commented Jan 2, 2022

I plan to release it until the end of January, hopefully sooner. But unfortunately I can't guarantee it ;)

@Glitchy-Tozier
Copy link
Contributor Author

Understood :)

@stefan-k
Copy link
Member

v0.5.0 is released!

@Glitchy-Tozier
Copy link
Contributor Author

Amazing, thank you for notifying me! :)

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

Successfully merging this pull request may close these issues.

2 participants