peggyjs / peggy

Peggy: Parser generator for JavaScript
https://peggyjs.org/
MIT License
906 stars 64 forks source link

Add developer docs. #469

Closed hildjj closed 6 months ago

hildjj commented 6 months ago

Fixes #466.

hildjj commented 6 months ago

@frostburn please review.

frostburn commented 6 months ago

Looks good and got the project up and running on my end. :+1:

Additional remarks

  1. It would be nice to link to CONTRIBUTING.md in README.md.
  2. After the setup described in this PR I got untracked files docs/package-lock.json and web-test/package-lock.json. These should be either included in the repository or added to .gitignore.
  3. It might've been npm run lint but docs/js/test-bundle.min.js ends up modified on my end according to git.
hildjj commented 6 months ago
  1. willfix
  2. willfix, was playing with workspaces, but decided I didn't like them.
  3. I might not have checked in my last test fixes minified. willfix.