search

mentaljam / standard_paths

A Rust port of QStandardPaths class which provides methods for accessing standard paths on the local filesystem (config, cache, user directories and etc.).
https://docs.rs/crate/standard_paths
MIT License
7 stars 1 forks source link

Clarify supported operating systems #1

Closed sanmai-NL closed 6 years ago

sanmai-NL commented 6 years ago

The most important issue in evaluating this crate is what operating systems it supports. Right now you mention it works on Windows and Unix. Reading https://doc.rust-lang.org/reference/attributes.html#conditional-compilation, it appears as if this includes macOS, but one can’t be too sure. Could you elaborate a bit in the README and API docs to make this 100 % clear to every potential user?

sanmai-NL commented 6 years ago

Extra note. The QStandardPaths docs themselves are clear. Your port is still early, though, compared to the current maturity of QStandardPaths, so that doesn’t reflect the supported OS’es yet. A potential source of confusion.

mentaljam commented 6 years ago

I fully agree with your comment. I have no ability to test it on macOS and don't want to publish any "blind" changes. So currently macOS is leaved unsupported until someone helps with it.

mentaljam commented 6 years ago

Please let me know if this issue could be closed now.

sanmai-NL commented 6 years ago

Yes, thanks!

macOS can be tested via Travis CI. Would be wise to call for help in the README too, there are probably many Rustaceans using macOS. 🙂