README：让别人 30 秒理解项目 | GitHub

本章覆盖：project positioning；screenshot / demo；feature；architecture；tech stack；quick start；configuration；database；API；testing；deployment；known limitations；roadmap；license；避免 README 变成无结构的技术名词堆砌。

本章知识点

  • project positioning
  • screenshot / demo
  • feature
  • architecture
  • tech stack
  • quick start
  • configuration
  • database
  • API
  • testing
  • deployment
  • known limitations
  • roadmap
  • license
  • 避免 README 变成无结构的技术名词堆砌