Node Serialport

[reconbot]

Node Serialport is a widely used nodejs serialport library. I have users from all languages and countries, a lot of people new to javascript development and software development as a whole. To make it even more interesting we have at least 3 versions of serialport in wide use and the very old ones have a lot of bugs.

I have a few goals;

• Making sure non english speakers can approach the documentation.
• Making sure people can find and understand the installation guides, as a lot of support issues are solved by linking people to the docs.

https://github.com/EmergingTechnologyAdvisors/node-serialport

[LappleApple]

Hey @reconbot, I'd edit this if I could skip over all the jsdoc stuff and do a simple fork-and-PR.

[reconbot]

What about it is preventing you?

[LappleApple]

I just want to edit in the browser

[reconbot]

If you start that way I'd be happy to help put the text in the right places. Jsdoc was invaluable in helping to have much better API documentation but it does spread out the API docs.

On Mon, May 1, 2017, 6:43 AM Lauri Apple notifications@github.com wrote:

I just want to edit in the browser

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/LappleApple/feedmereadmes/issues/3#issuecomment-298317539, or mute the thread https://github.com/notifications/unsubscribe-auth/AABlbo6Y1Y_48V3NpCZwWX0YJ_Sif5Qhks5r1bdfgaJpZM4Mw7iR .

[LappleApple]

That could work, @reconbot. I'll fork your repo, create an edited version of the README and then you can copy/paste the text into your README.md. Does that sound OK?

[reconbot]

Sounds good

---

Francis Gulotta wizard@roborooter.com

On Wed, May 3, 2017 at 7:55 AM, Lauri Apple notifications@github.com wrote:

That could work, @reconbot https://github.com/reconbot. I'll fork your repo, create an edited version of the README and then you can copy/paste the text into your README.md. Does that sound OK?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/LappleApple/feedmereadmes/issues/3#issuecomment-298890190, or mute the thread https://github.com/notifications/unsubscribe-auth/AABlbpQ79O2gpN7SXs_9Hvezun5bBr_sks5r2GsogaJpZM4Mw7iR .

[LappleApple]

Hey @reconbot, I've been busy flying around and traveling, but now that's over and I'll get to this by the weekend. Look for a PR from me. :)

[LappleApple]

@reconbot: I started editing. Everything above the TOC: https://github.com/LappleApple/node-serialport

I also moved the License section to the bottom and added the text. Will continue ...

[reconbot]

Feel free to make a WIP (work in progress) PR whenever you'd like some feedback. Looks good so far!

[LappleApple]

Thanks, @reconbot. I'll continue where I left off and finish. :)

[LappleApple]

@reconbot Is this line under the Alpine Linux section missing the end?

# If you're installing as root, you'll need to use

[reconbot]

That should refer to the --unsafe-perm flag mentioned in the sudo/root section https://github.com/EmergingTechnologyAdvisors/node-serialport#sudo--root

[LappleApple]

@reconbot Hi: I made a PR to let you know I'm ready for you to take over with the copy/pasting. :)