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

README directions are incorrect #29

Closed
brentzundel opened this issue May 21, 2019 · 2 comments
Closed

README directions are incorrect #29

brentzundel opened this issue May 21, 2019 · 2 comments

Comments

@brentzundel
Copy link
Member

The README directions for submitting an implementation report have some errors.
4. Rename implementation/results.json to implementation/YOUR_IMPLEMENTATION-results.json.
should be:
4. Rename implementations/report.json to implementations/YOUR_IMPLEMENTATION-report.json.

5. git add implementations/YOUR_IMPLEMENTATION-results.json and submit a pull request for your implementation.
should be:
5. git add implementations/YOUR_IMPLEMENTATION-report.json and submit a pull request for your implementation.

And it is unclear what the purpose of this instruction is:
6. cd implementations/ && node generate.js

@dmitrizagidulin
Copy link
Collaborator

Thanks for the catch, re typo. This'll be fixed along with the fix to issue #14.

(The purpose of step 6, node generate.js is to convert the report.json into html of the implementation report page)

@dmitrizagidulin
Copy link
Collaborator

Fixed by PR #33.

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

No branches or pull requests

2 participants