kernel_tuner icon indicating copy to clipboard operation
kernel_tuner copied to clipboard

redesigning the readme

Open benvanwerkhoven opened this issue 2 years ago • 1 comments

I'd like to give the README a big update at some point, including:

  • [x] logo designed by Stijn
  • [x] vastly reduce amount of text, just point to documentation
  • [ ] more about performance and productivity impact of auto-tuning
  • [ ] potential energy gains using auto-tuning with Kernel Tuner
  • [x] bunch of logos of institutes where Kernel Tuner is used in production
  • [ ] pointers to related tools: Tutorial, Kernel Launcher, Kernel Float, Dashboard
  • [ ] listing the Kernel Tuner Developers team as core developers
  • [x] categorize the 'please cite these papers' section

Any other suggestions?

benvanwerkhoven avatar Mar 24 '23 07:03 benvanwerkhoven

Some suggestions:

  • Short list of features at the top (like 4-5 bullets)
  • Table showing supported backends
  • List of FAQ (could also be in documentation)
  • Section on what to do if you run into a bug/issue/feature request.

stijnh avatar Mar 30 '23 08:03 stijnh

This has been resolved by PR #231

stijnh avatar Mar 12 '24 16:03 stijnh