Hacker News new | past | comments | ask | show | jobs | submit login

Things I want:

* lots of screenshots

* a README.md that is extremely long and detailed

* tutorials, reference, design documents, architecture diagrams

* mental model documents to explain how things are thought of by the authors




A description of the file system structure of the repository. Explains how things are organized, where existing stuff is located and where to add new stuff.

I run tree on the repository root, append the output to the README and add comments to every line explaining every directory and sometimes every file.


Adding to the list:

* Approachable CONTRIBUTING.md with a brief technical overview and suggestions on how to get started.


* functional, tested example code




Join us for AI Startup School this June 16-17 in San Francisco!

Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: