Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NPM Documentation Incorrect #767

Closed
machineghost opened this issue Sep 8, 2016 · 3 comments
Closed

NPM Documentation Incorrect #767

machineghost opened this issue Sep 8, 2016 · 3 comments
Labels

Comments

@machineghost
Copy link

The documentation on Sigma's NPM page is ... misleading:

How to use it
To use it, clone the repository:
git clone git@github.com:jacomyal/sigma.js.git

Since I'm pretty sure anyone running npm install sigma should not be running git clone git@github.com:jacomyal/sigma.js.git, it'd be nice if this documentation could be updated.

In particular it would be nice to see how NPM users can/should access plugins (are they part of the main package, do you need to install separate packages for them, etc.).

@alokkulkarni
Copy link

thats correct, i think the document should really update to say

"npm install sigma" or mention it to add it in the dependency package.json file as "sigma": "jacomyal/sigma.js" and run npm install.

@stale
Copy link

stale bot commented Oct 8, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Oct 8, 2021
@stale stale bot closed this as completed Oct 23, 2021
@machineghost
Copy link
Author

Thus should be re-opened: the documentation has been broken for 5 years now, it's high time to fix it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants