README-Driven Design
summary
Shows how a single README.org literate source generates code, docs and diagrams using Org Mode and Graphviz, with concrete steps: add :tangle and :noweb refs, preview tangled output with C-c C-v C-v, run org-babel-tangle to write main.go, run go build to produce demo, and execute it to print "Hello EmacsConf." Demonstrates weaving to GitHub-flavored Markdown via org-gfm-export-to-markdown, keeping no-export sections intact and verifying the file system contains main.go, demo, PNG and README.md.
AI-written summary · about
chapters (7)
- 0:00Introduction to README-Driven Design
- 1:08Setting up README.org file
- 3:17Literate programming basics
- 8:46Tangling and generating code
- 10:33Building and running the project
- 12:00Structuring literate sections
- 17:08Weaving documentation from Org
related talks
31mREADME Driven Development
35mThe Art of Documentation and Readme.md for Open Source Projects
22mWrite Prose, Not just programs
35mThe practical implementation of Documentation as Code
48mBeyond Words: Crafting User-Friendly Documentation
46mThe Underrated (But Amazing) Emacs org-mode
42mEngineering Documentation
47mOrg-Mode for Science, Reproducible Research, and Organization