the source should live in src, the README should contain the basics and link out to the following pieces of documentation (still in the README or standalone):
platform advice for compiling the tool
general tips for coaxing a compilation database to work for a project
runbooks of successful lsif indexes of popular OSS repos
the source should live in src, the README should contain the basics and link out to the following pieces of documentation (still in the README or standalone):