updated README according to the new fix

Mergesorting very large arrays with colla doesn't segfault anymore, at least
not before the standard malloc/free scheme starts to segfault.
cleanup

 * better formatting for debugging messages
 * including headers only when necessary
 * linting
added some TODOs

 * colla_realloc
 * colla_defragment