People don't have time for all these "random" stuff, prepare a proper readme containing:

1. what this project is
2. how to run it
3. warning about issues
4. citation and related projects and acknowledgement