ColaroidColaroid is designed for "literate programming" -- it allows you to embed code in a document to create computational narratives. It stands out from other computational notebooks as it is created for documenting code evolutions. Colaroid can be used for a variety of programming tasks where storytelling matters. FeaturesDescribe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. For example if there is an image subfolder under your extension project workspace: ![feature X](images/feature-x.png)
RequirementsIf you have any requirements or dependencies, add a section describing those and how to install and configure them. Extension SettingsInclude if your extension adds any VS Code settings through the For example: This extension contributes the following settings:
Known IssuesCalling out known issues can help limit users opening duplicate issues against your extension. Release NotesUsers appreciate release notes as you update your extension. 1.0.0Initial release of ... 1.0.1Fixed issue #. 1.1.0Added features X, Y, and Z. Following extension guidelinesEnsure that you've read through the extensions guidelines and follow the best practices for creating your extension. Working with MarkdownNote: You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
For more informationEnjoy! |