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

Create README.md #761

Merged
merged 4 commits into from
Jun 22, 2023
Merged

Create README.md #761

merged 4 commits into from
Jun 22, 2023

Conversation

serenayl
Copy link
Contributor

@serenayl serenayl commented Jan 19, 2022

BACKGROUND:

  • I did not know how to run benchmarks.

DESCRIPTION:

  • I put some documentation on how to run benchmarks.

TESTING:

  • Follow the readme successfully.

FUTURE WORK:

  • Make this documentation more comprehensive.

REQUIRED:
- [ ] All changes are up to date in CHANGELOG.md.

COMMENTS:

  • N/A

This change is Reviewable

@serenayl serenayl requested a review from ikeough January 19, 2022 17:13
Copy link
Contributor

@ikeough ikeough left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 1 change requests, 0 of 1 approvals obtained (waiting on @serenayl)


Elements.Benchmarks/README.md, line 1 at r1 (raw file):

## How to run benchmarks

There is this: https://github.com/hypar-io/Elements/blob/master/README.md#benchmark. Should we re-point this to this readme?

Copy link
Contributor Author

@serenayl serenayl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 1 change requests, 0 of 1 approvals obtained (waiting on @ikeough)


Elements.Benchmarks/README.md line 1 at r1 (raw file):

Previously, ikeough (Ian Keough) wrote…

There is this: https://github.com/hypar-io/Elements/blob/master/README.md#benchmark. Should we re-point this to this readme?

Done.

Copy link
Contributor

@anthonie-kramer anthonie-kramer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: :shipit: complete! 1 change requests, 1 of 1 approvals obtained (waiting on @ikeough)

@serenayl serenayl merged commit 9e3917f into master Jun 22, 2023
2 checks passed
@serenayl serenayl deleted the benchmarks-documentation branch June 22, 2023 19:02
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

Successfully merging this pull request may close these issues.

None yet

3 participants