search

AMythicDev / minus

An asynchronous, runtime data feedable terminal paging library for Rust
https://crates.io/crates/minus/
Apache License 2.0
317 stars 23 forks source link

doc: adding keybinding entry for toggling follow-mode #117

Closed TornaxO7 closed 9 months ago

TornaxO7 commented 9 months ago

I forgot this in https://github.com/arijit79/minus/pull/114 :D

AMythicDev commented 9 months ago

You should also them in the README as well.

TornaxO7 commented 9 months ago

You should also them in the README as well.

Hm... I've got an idea: Why add a link to the README which brings them to the doc section for key bindings so that you don't have to maintain both tables?

AMythicDev commented 9 months ago

Yeah! That could be done as well. I will merge this and then we can refactor the README in a separate PR.

Edit: Actually I need some help in this matter. Although I have good experience in software engineering and stuff, I am kinda bad at writing documentations and help. Also English isn't my first language so that also introduces a bit of hassle for me. So if you can devote some time to just go through the documentation as a person trying to use minus inside the project as well as a person who wants to start contributing to minus and report me those issues or fix them yourself, that would be of great help to this project. I hope this won't put a huge burden on you. It's a simple request. Thanks in advance.

TornaxO7 commented 9 months ago

Edit: Actually I need some help in this matter. Although I have good experience in software engineering and stuff, I am kinda bad at writing documentations and help. Also English isn't my first language so that also introduces a bit of hassle for me. So if you can devote some time to just go through the documentation as a person trying to use minus inside the project as well as a person who wants to start contributing to minus and report me those issues or fix them yourself, that would be of great help to this project.

Okeydokey :)

I hope this won't put a huge burden on you. It's a simple request. Thanks in advance.

Should be fine :)

AMythicDev commented 9 months ago

That's so great of you. Now, you don't have to go through everything in one go or in a day as I too don't get much time to work on minus. Hence we will take each module one by one every few days and improve it by making separate PRs. It would be beneficial if you have joined either discord/matrix so that it is easier to chat on stuff.

TornaxO7 commented 9 months ago

tornaxo7 here's my discord user name :)