Documentation

[as27]

All PRs for a better documentaion are welcome.

Better documentation of the code or a better reamde.

I am not so fluent in writing good English, so every doc element is welcome.

[gracyashhh]

Can you assign this to me, I'll help you with a fluent Documentation 👍

[as27]

You can go for it. If you need some information don't be shy to ask.
At all this app is at the moment just a prototype, but the target is to check how everyone likes this kind of navigation of a filebrowser. So a good ReadMe and/or documentation is important to get as many peoply into this and to get a lot of different feedbacks.

[gracyashhh]

Sure, Thanks!!

…

On Mon, Oct 12, 2020 at 11:40 PM Andreas Schröpfer ***@***.***> wrote: You can go for it. If you need some information don't be shy to ask. At all this app is at the moment just a prototype, but the target is to check how everyone likes this kind of navigation of a filebrowser. So a good ReadMe and/or documentation is important to get as many peoply into this and to get a lot of different feedbacks. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#17 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANN5DK56NYHBYYKHNNCRPL3SKNBADANCNFSM4SMYD5GA> .

[gracyashhh]

Is there anymore details other than the ones already specified that you'd like me to add to the documentation..? If so, kindly mention and I'll add them all at once

[as27]

There is never too much documentation.

• there are 2 modes
  • command mode
  • browse mode
• left and right side of a folder view
• actions go from left to right
  • example: copy or move
• short introductions of the commands. Look here for tha availiable commands: https://github.com/as27/gomd/blob/479cfb9e81b0e8438b246994b9cdb7512048a40c/cmd/gomd/commands.go#L11:L20

If you are familiar with go, it is also welcome to document the inside the code.

[gracyashhh]

Sure, will update after which you can merge the pull request