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.

Sign up for GitHub

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

Jump to bottom

Following the readme verbatim causes errors #607

Open
zalatar242 opened this issue Jan 1, 2025 · 0 comments
Open

Following the readme verbatim causes errors #607

zalatar242 opened this issue Jan 1, 2025 · 0 comments

Comments

@zalatar242
Copy link

zalatar242 commented Jan 1, 2025 •
edited
Loading

Bug Report

The readme is not updated with the latest code changes. There is a lot of missing information so getting started/using the code takes much longer than expected.

General problems

  • needs links to additional sources
  • inconsistencies with variable names
  • lacking info on unimported use of variables

Package name / version

Description

Steps to reproduce

Expected behavior

Environment

  • OS: [e.g., OSX 10.13.4, Windows 10]
  • Node/npm version: [e.g., Node 8/npm 5]
  • Browser: [e.g., Chrome]

Additional context / screenshots
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@zalatar242 and others