Document which platforms are supported

google / vim-syncopate

Make it easy to share beautiful code. DISCLAIMER: This is not an official Google product.

Apache License 2.0

90 stars 16 forks source link

Document which platforms are supported #13

Closed dbarnett closed 9 years ago

dbarnett commented 9 years ago

There's no a priori reason to expect syncopate wouldn't work on Windows or any other given platform, but it seems to have poor-to-nonexistent support for Windows and doesn't mention what platforms are supported anywhere.

We should document which platforms are completely unsupported in README/docs and/or handle corner cases better (e.g., don't default to sensible-browser on platforms that don't have it).

chiphogg commented 9 years ago

My intent is that a) the API will eventually support all platforms, and b) we'll need help from users of those platforms to get there. Certainly, in the meantime we should be clear about what's working and what's not, while also being clear that we welcome help for the latter.