search

pjeby / pane-relief

Obsidian plugin for per-pane history, pane movement/navigation hotkeys, and more
223 stars 6 forks source link

add screenshots or intuitive interpretations to the README #4

Closed YQGong closed 3 years ago

YQGong commented 3 years ago

Hi, thank you for your great work.

Because there were too many words in the README but no screenshots, it took me a long time to figure out what the plug-in did. I think the current Readme may be losing many users, and if the plug-in's functionality could be explained more intuitively, the project would be very popular.

pjeby commented 3 years ago

What would this screenshot show? Everything is a keyboard command, and I'm not sure how you'd visualize the history part, either. If you have screenshots or other things to offer, feel free to share, but the reason I haven't is because I have no idea what to put.

YQGong commented 3 years ago

You are right, visualization is not easy and maybe a screenshot is not a good idea. I drew a sketch to explain the function of this plugin. If you think this is helpful, feel free to use and modify it.

image

figure.pptx

pjeby commented 3 years ago

Hm. I wrote this plugin and I don't understand that diagram. :wink: So I'm not sure how much it would help anything. I suppose a video (with sound) would probably be the only way to really make it work and I honestly don't care that much, it's not like getting more users for this plugin actually does anything for me. I'm just making it available so other people can use it.

Now, something I do have planned for a future release is to make the history arrows show a number and be able to be right-clicked to show forward and back history. A screenshot of that would be possible, or even a short animation to show the numbers and lists changing when switching between panes. That would probably suffice to get the message across, I imagine.