blob: f62e548ba3e42dd021f58bdeb1cd1181fb243670 [file] [log] [blame] [view]
Roman Elizarovb3d55a52017-02-03 12:47:21 +03001# Knit
2
3This is a very simple tool that produces Kotlin source example files from a markdown document that includes
4snippets of Kotlin code in its body. It is used to produce examples for
Roman Elizarovf23274a2017-05-17 13:27:30 +03005[coroutines guide](../coroutines-guide.md) and other markdown documents.
Roman Elizarov6c18dfd2017-06-23 13:27:02 +03006It also includes links to the documentation web site into the documents.
Roman Elizarovb3d55a52017-02-03 12:47:21 +03007
Roman Elizarovf23274a2017-05-17 13:27:30 +03008## Usage
Roman Elizarov419a6c82017-02-09 18:36:22 +03009
10* In project root directory do:
Kirill Timofeeva5186962017-10-25 14:25:47 +030011 * Run `./gradlew knit`
Roman Elizarovf23274a2017-05-17 13:27:30 +030012* Commit updated documents and examples
Kirill Timofeeva5186962017-10-25 14:25:47 +030013