10

What information would you expect to see in the github README?

Should everything go in the README? i.e.

  • Introduction

  • Installation

  • Versions

  • User Guide

  • Implementation

  • Testing

  • Related Resources

Or should you just put certain things in the README (Introduction, Installation, Versions) and the other information is best placed in the Github wiki?

7

I expect to see an introduction and brief overview. There should be something there to convince me that the project solves a particular problem. After reading the README, I should know enough information to know what the project does, what it requires, how to build it, and how to use it. That information doesn't all need to be in the README, but links to that information should be.

  • 1
    +1 for brief. Don't say "README" and then put a bunch of garbage in that doesn't need to be read. – Korey Hinton Jun 24 '13 at 16:22

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Not the answer you're looking for? Browse other questions tagged or ask your own question.