search

luni64 / EncoderTool

The EncoderTool is a library to manage and read out rotary encoders connected either directly or via multiplexers to ARM based boards. Encoder push buttons are supported. Callback functions can be attached to encoder changes and button presses to allow for event driven applications
MIT License
48 stars 12 forks source link

README Formatting #15

Closed ElectronicsArchiver closed 2 years ago

ElectronicsArchiver commented 2 years ago


Please check the Preview.



Changes



Repository Suggestions


luni64 commented 2 years ago

Thanks, I like the general layout! I usually prefer WIKIs over a documentation folder because WIKIs are not part of the downloaded repo and thus don't bloat projects. Anyway, do you have some kind of automatic WIKI -> MD converter to give it a try?

I'm currently working on making the library compatible to more platforms. Will take a few days but the corresponding release might be a good opportunity to also change the layout and (maybe) the documentation system

ElectronicsArchiver commented 2 years ago

Not automatic, no, I would just do it :3 Btw, an option would also be to have a dedicated branch for the documentation~

ElectronicsArchiver commented 2 years ago

So, should I work on a PR regarding that?

luni64 commented 2 years ago

So, should I work on a PR regarding that? Having the documentation in a folder? Thinking of it, might be a good idea after all. Including images in the wiki is kind of tedious. Should be easier in a folder. So, if you really want to invest some time in it, go ahead :-).

Btw, an option would also be to have a dedicated branch for the documentation~ I assume one could link to that from the master branch right? Having users to actively switch branches to read the documentation would probably confuse them. So, lets give that a try.

Thanks for supporting this.

ElectronicsArchiver commented 2 years ago

I assume one could link to that from the master branch right?

Yes.

ElectronicsArchiver commented 2 years ago

I'd work on a Documentation folder first and if wanted it can be transferred into a dedicated branch later on~

luni64 commented 2 years ago

Great

luni64 commented 2 years ago

Are you still interested in this? I would like to work on the documentation soon but would prefer to work from the new structure. If not, would you mind doing a PR with the current status?

ElectronicsArchiver commented 2 years ago

Yes, I'm still working on it, was a bit busy, I'll try to finish it up~

ElectronicsArchiver commented 2 years ago

And here's the Draft PR #18