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

Document ReBench and fix consistency issues #66

Merged
merged 12 commits into from
Jul 14, 2018
Merged

Document ReBench and fix consistency issues #66

merged 12 commits into from
Jul 14, 2018

Conversation

smarr
Copy link
Owner

@smarr smarr commented Jun 2, 2018

The goal of this PR is to have a proper user documentation.

The documentation is going to be available at: rebench.readthedocs.io

The key elements that need to be described are:

  • the configuration format
  • how to use ReBench
  • how to extend it for other harnesses
  • an explanation of the basic concepts/terminology

@smarr smarr added the Feature label Jun 2, 2018
@smarr smarr added this to the v1.0 - Foundation milestone Jun 2, 2018
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.2%) to 81.476% when pulling 7e1e13b on documentation into 20c27cb on master.

@coveralls
Copy link

coveralls commented Jun 2, 2018

Coverage Status

Coverage increased (+0.2%) to 84.258% when pulling 4780da2 on documentation into 113211e on master.

Signed-off-by: Stefan Marr <git@stefan-marr.de>
@smarr smarr force-pushed the documentation branch 14 times, most recently from 84462c5 to f4ee4da Compare July 14, 2018 21:15
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
Seems to be the better wording.

Signed-off-by: Stefan Marr <git@stefan-marr.de>
Signed-off-by: Stefan Marr <git@stefan-marr.de>
@smarr smarr merged commit 2b5a6a8 into master Jul 14, 2018
@smarr smarr deleted the documentation branch July 14, 2018 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants