How to Document CLI Tools Using Readme

Simon Willison uses Cog in a number of places to keep his documentation up to date. Colin says using Cog to document CLI tools is Chef's Kiss. We're almost out of time, but luckily we're also almost out of things to talk about. Let's do the test. Click on their profiles. See how it looks. You can take this a long way. Like I said, you might want to publish information in more than one place. For instance, my change log is in the.rst file, but it also goes into GitHub releases because people want to read it and get help releases. Simon: "I've used Cog to an extreme extent in my