Browse Source

Add README for bundle + consmetic changes

master
Futago-za Ryuu 3 years ago
parent
commit
7deb6a779e
  1. 2
      docs/notes/development.md
  2. 2
      tools/benchmark/README.md
  3. 1
      tools/bundle/README.md
  4. 4
      tools/impact/README.md

2
docs/notes/development.md

@ -27,6 +27,6 @@ _Ensure you have Node.js v6+ and Yarn installed._
7. Push the commits from your clone to the fork
8. From your fork, start a new pull request
It's also a good idea to check out the [gulpfile.js](https://github.com/pegjs/pegjs/blob/master/gulpfile.js) that defines various tasks that are commented with a description of each task.
It's also a good idea to check out the [package.json](https://github.com/pegjs/pegjs/blob/master/package.json) that defines various scripts.
To see the list of contributors check out the [repository's contributors page](https://github.com/pegjs/pegjs/graphs/contributors).

2
tools/benchmark/README.md

@ -3,5 +3,5 @@ This directory contains the benchmark suite that measures the speed of parsers g
From the root of the repository:
```sh
yarn benchmark
npx benchmark
```

1
tools/bundle/README.md

@ -0,0 +1 @@
This directory contains a package bundler for PEG.js that is actually a thin layer around [Rollup](https://rollupjs.org/).

4
tools/impact/README.md

@ -3,6 +3,6 @@ This directory contains a tool used on the PEG.js repository that measures the i
From the root of the repository:
```sh
yarn impact <commit>
yarn impact <commit_before> <commit_after>
npx impact <commit>
npx impact <commit_before> <commit_after>
```
Loading…
Cancel
Save