Reduce README length by dividing into smaller documents

RobotWebTools / rclnodejs

Node.js version of ROS 2.0 client

https://docs.ros.org/en/humble/Concepts/Basic/About-Client-Libraries.html?highlight=rclnodejs#community-maintained

Apache License 2.0

316 stars 70 forks source link

Reduce README length by dividing into smaller documents #769

Closed wayneparrott closed 3 years ago

wayneparrott commented 3 years ago

README.md

added Documents section with TOC

./docs/BUILD.md

build instructions

./CONTRIBUTORS.md

list of contributors and short description of each contributors work.

./docs/CONTRIBUTING.md

short guide for how to contribute to the project

./docs/FAQ.md

faq topics and known issues

Fix #761 Update README.md Added contributing guidelines.

coveralls commented 3 years ago

Coverage remained the same at 91.787% when pulling f36af5369de2a2a13e10f85ba4b0946d08e94b34 on wayneparrott:readme_refactor_761 into d8d7de214467d12123024ef0d74dd51ebf2ad0cb on RobotWebTools:develop.