search

Shared-Reality-Lab / IMAGE-browser

IMAGE project browser extensions & client-side code
Other
2 stars 0 forks source link

Updates to readme for iOS #359

Closed jeffbl closed 6 months ago

jeffbl commented 9 months ago

@21satvik I've made a number of edits, and inserted some [SATVIK: ] comments for you to look at. Two other points of confusion to clarify:

  1. The instructions for the main README are just for the OSX desktop version of Safari correct? That should be clarified if so.
  2. I'm a little confused about the split of instructions between the main README.md and Safari.md. Would it be better to just have a single sentence in README.md that points to Safari instructions for both OSX and iOS, then have sections for building from scratch, converting the existing extension, or using the automatically built artifacts? I fear someone going here will not be clear on what to do, and which set of instructions to follow.
jeffbl commented 8 months ago

@21satvik are you still planning to revise this? thanks!

jeffbl commented 7 months ago

I reworded part of Safari.md to be clearer about the automatically generated artifacts. Please verify this is correct, and if there is further explanation, please include. One thing it implies is that the desktop Safari extension artifact is installable, but not the iOS one. Please correct if necessary, and if true, would be good to make that more clear.

Also put in some comments on README.md, especially on removing the parts that are redundant with Safari.md. (EDIT: I went ahead and made proposed changes. Please adjust as you see fit, especially if there was information there that only existed in README.md. Thanks!)

21satvik commented 6 months ago

@jeffbl This can be merged on to main branch