Your project’s README is your project’s constitution

Most open source project maintainers treat READMEs as mere marketing material or technical documentation. Yes, your project README can and should tell others what your project does and how they can use it, but at its most fundamental level, the README serves as your project’s foundational document, memorializing and communicating the project’s core goals, philosophies, and underlying assumptions. Well-focused projects are healthy projects. Among the first things I do when I start a new project i...

Submit