Working with serial ports can be hard, this is a collection of docs that make it easier.
Go to https://serialport.io/ to learn more, find guides and api documentation.
To provide api docs, guides and explanations to make using serial ports easier.
Versioned docs are for major versions of serialport and should be kept up to date with the latest version of the package.
New docs should be added to the /docs directory.
You can develop the docs by running
npm run startAnd build them by running
npm run buildDocs are automatically built with netlify including previews on branches. The master branch is deployed to https://serialport.io
We use Remarkable Admonitions to add easy to notice asides for tips, warnings and other admonitions. Give it a try.
SerialPort packages are all MIT licensed and all it's dependencies are MIT licensed.
SerialPort follows the Nodebots Code of Conduct. While the code is MIT licensed participation in the community has some rules to make this a good place to work and learn.
- Be respectful.
- Abusive behavior is never tolerated.
- Data published to NodeBots is hosted at the discretion of the service administrators, and may be removed.
- Don't build evil robots.
- Violations of this code may result in swift and permanent expulsion from the NodeBots community.
SerialPort is currently employees a governance with a group of maintainers, committers and contributors, all fixing bugs and adding features and improving documentation. You need not apply to work on SerialPort, all are welcome to join, build, and maintain this project.
- A Contributor is any individual creating or commenting on an issue or pull request. By participating, this is you.
- Committers are contributors who have been given write access to the repository. They can review and merge pull requests.
- Maintainers are committers representing the required technical expertise to resolve rare disputes.
If you have a PR that improves the project people in any or all of the above people will help you land it.
Maintainers