search

saalfeldlab / paintera

GNU General Public License v2.0
100 stars 17 forks source link

Readme docs update, re-order usage table info #454

Closed GenevieveBuckley closed 1 year ago

GenevieveBuckley commented 2 years ago

This PR is mostly a re-ordering of existing information. Grouping the information in the "Usage" table into subsections according to function makes it easier to find the information you're looking for.

GenevieveBuckley commented 2 years ago

Oh, hang on - there are two files called README.md (one in the top level of the repository, and one under markdown/README.md).

Most of the content seems to be duplicated. Should I also copy my changes into the second readme file as well? What's the difference between the two?

cmhulbert commented 2 years ago

The nested README.md should just be a symlink to the top level one, so you shouldn't need to explicitly copy the changes. Thanks for clearing up some of the README.md!

GenevieveBuckley commented 2 years ago

The nested README.md should just be a symlink to the top level one, so you shouldn't need to explicitly copy the changes. Thanks for clearing up some of the README.md!

Ah, of course. I probably should have looked more closely.

I'm still not entirely sure where the content is being pulled for the key bindings dialog that pops up if you press F1 (or access it from the help menu). It seems separate from the README content. I found KeyBindingsDialog.kt, but I still don't see where it's getting the content from. Ideally these tables would also be organised in the same way, but I guess that can be done in another PR.

GenevieveBuckley commented 2 years ago

FYI, I've also added links to the two new youtube tutorial videos under the "Usage" heading. I think that's a good place for it.

I don't plan to make more changes to this PR, unless you request them.

GenevieveBuckley commented 2 years ago

Added some more information from Stephan's comment here, plus a link to the BigDataViewer docs on navigation controls since he says they are the same

cmhulbert commented 1 year ago

@GenevieveBuckley You'll see I merged your commits (as well as some other updates to the README) into the current master branch. Thanks for clearing providing these updates, definitely needed some more attention, and hopefully now it's a bit clearer. Thanks!