add pointer to design rationale doc

This commit is contained in:
gmega 2024-03-01 18:55:09 -03:00
parent f93ca4d4c7
commit 127378e32f
No known key found for this signature in database
GPG Key ID: FFD8DAF00660270F

View File

@ -1,7 +1,7 @@
chroprof - Profiling for [Chronos](https://github.com/status-im/nim-chronos)
============================================================================
This repo contains a usable profiler for [Chronos](https://github.com/status-im/nim-chronos). For the time being, it requires [a modified version of Chronos V4](https://github.com/codex-storage/nim-chronos/tree/feature/profiler-v4) which has profiling hooks enabled.
This repo contains a usable profiler for [Chronos](https://github.com/status-im/nim-chronos). For the time being, it requires [a modified version of Chronos V4](https://github.com/codex-storage/nim-chronos/tree/feature/profiler-v4) which has profiling hooks enabled. Some of the rationale for the design and implementation of the profiler [can be found here](https://hackmd.io/eQ_ouNV4QZe0TG334_gkFg).
1. [Enabling profiling](#enabling-profiling)
2. [Looking at metrics](#looking-at-metrics)