Added README Table of Contents.

michaelherold / benchmark-memory

Memory profiling benchmark style, for Ruby 2.1+

MIT License

217 stars 6 forks source link

Added README Table of Contents. #7

Closed bkuhlmann closed 5 years ago

bkuhlmann commented 5 years ago

Overview

Provides quick navigation for readers of this gem. This was auto-generated via the Tocer gem.

Usage:

tocer --generate

Notes

Due to this project not having a hard Ruby version requirement (i.e. .ruby-version), I could add Rake task support for future autogeneration of Table of Contents for convenience if desired (or leverage Gemsmith for full gem maintenance automation :wink:).

michaelherold commented 5 years ago

Thanks for the contribution!

I'd love the Rake integration, but I'm not interested in using Gemsmith because I have a process that I've worked through. If you would like to add a Rake task to make tocer run like the rest of the tools, I'll be happy to merge this.

bkuhlmann commented 5 years ago

:bow: @michaelherold, sounds good. Would you mind if I open new PR for Rake support so this one is unblocked?