search

flynneva / react-ros

Connect your website to your robot!
https://flynneva.github.io/react-ros/
54 stars 11 forks source link

README.md differentiates two modes of npm install #33

Closed newcanopies closed 3 years ago

newcanopies commented 3 years ago

formerly: $ npm install react-ros

npm ERR! code ENOSELF
npm ERR! Refusing to install package with name "react-ros" under a package
npm ERR! also called "react-ros". Did you name your project the same
npm ERR! as the dependency you're installing?
npm ERR!
npm ERR! For more information, see:
npm ERR! https://docs.npmjs.com/cli/install#limitations-of-npms-install-algorithm
flynneva commented 3 years ago

so i think i like this feedback but I think its more of a "miscommunication" then an error in the readme. that install step is for people who want to add it to an existing npm project, not clone and install/build this specific repo.

so I think a better change would be to add two separate install steps - one for people who want to add it to an existing project and another to install/build this specific repo.

what do you think?

newcanopies commented 3 years ago

separate install steps - one for people who want to add it to an existing project and another to install/build this repo.

Good clarification. Changed Install to Add react-ros to existing npm project

Since the standalone install has a somewhat limited use-case relevant to those starting their ROS package dev from the web-cli, feel free to retain/remove.

flynneva commented 3 years ago

LGTM! Thanks for the pr