fix for readme - Githubissues

khoih-prog / SAMD_TimerInterrupt

This library enables you to use Interrupt from Hardware Timers on an SAMD-based board. These SAMD Hardware Timers, using Interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That's mandatory if you need to measure some data requiring better accuracy. It now supports 16 ISR-based Timers, while consuming only 1 Hardware Timer. Timers' interval is very long (ulong millisecs). The most important feature is they're ISR-based Timers. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. SAMD21 now can use 6 Timers

MIT License

34 stars 15 forks source link

Hi John,

Thanks for your interest and contribution to this library.

As you know, there is so much a single guy can do. I've been spending most of my time to research, fix bugs, create new libraries and certainly neglecting the README, as documenting is one of my many weakness. Just tries my best to write, copy and paste from my other libraries, hoping that's enough for anybody to start.

As always, the tech guys have the tunnel vision and don't know what is better and more important to document.

I'm sure there are many and many more issues with the README (grammar, typo, sentence, organization, etc.).

I'd appreciate if you can go through this README as well as my other libraries' README files to edit, correct, reorganize, etc. as you see fit. Your contribution will be very valuable to other new users.

I'll wait and won't merge this PR until you finalize and post all the fixes of this library's README.

Best Regards,

Hello Khoih,

Indeed. I am submitting the pull request and readme issue to help. I appreciate your work and expertise. I was trying to use the code today and the minor typo threw me off for a bit. Once I figured out the problem I thought, hmm, rather than point out the issue via text I should just issue a pull request.

Once again, I appreciate your expertise and I wish you the best,

John

On Fri, Jul 30, 2021 at 2:23 PM Khoi Hoang @.***> wrote:

Hi John,

Thanks for your interest and contribution to this library.

As you know, there is so much a single guy can do. I've been spending most of my time to research, fix bugs, create new libraries and certainly neglecting the README, as documenting is one of my many weakness. Just tries my best to write, copy and paste from my other libraries, hoping that's enough for anybody to start.

As always, the tech guys have the tunnel vision and don't know what is better and more important to document.

I'm sure there are many and many more issues with the README (grammar, typo, sentence, organization, etc.).

I'd appreciate if you can go through this README as well as my other libraries' README files to edit, correct, reorganize, etc. as you see fit. Your contribution will be very valuable to other new users.

I'll wait and won't merge this PR until you finalize and post all the fixes.

Best Regards,

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/khoih-prog/SAMD_TimerInterrupt/pull/6#issuecomment-890073404, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABBXUHGU3BE7JNKJUDAUSN3T2LU3XANCNFSM5BI24QEQ .

-- John F. Davis 6 Kandes Court Durham, NC 27713 919-888-8358 Public Profile https://www.linkedin.com/in/netskink

独树一帜

khoih-prog / SAMD_TimerInterrupt

fix for readme #6