A brief overview of Velox (maybe the 1st section of programming guide)
A link to the website
A link to the mailing list
A link to the programming guide
A "Getting Started" section
The goal should be that from the README, the reader knows what Velox is, an example of the type of problem Velox solves, and has enough information to start playing with Velox. The final part of the README should tell the reader where to find additional resources.
dcrankshaw
commented
9 years ago
The README should have
The goal should be that from the README, the reader knows what Velox is, an example of the type of problem Velox solves, and has enough information to start playing with Velox. The final part of the README should tell the reader where to find additional resources.