Description
The readme has a lot of excellent documentation on inputs to Miri (e.g. all the options that can be passed into MIRIFLAGS), but currently has relatively little to say about Miri's output. It would be great to have examples of common errors produced by Miri and how to read them.
It would also be helpful to have some quick documentation of the notation used in errors. For example, in this error message:
error: Undefined Behavior: trying to reborrow <349938> for Unique permission at alloc136736[0x0], but that tag does not exist in the borrow stack for this location
There are two bits of notation: <349938> and alloc136736[0x0]. I think <123> represents a tag, and maybe the [0x0] represents an offset from an allocation? Whatever the case is, would be great to have it documented in the readme.