Skip to content

Commit 0a195cd

Browse files
committed
Added info about kaitai stream API
1 parent b5f6238 commit 0a195cd

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

kaitai/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ A Kaitai Struct download provides two main tools in order to develop the code as
1616

1717
* See `simple_kaitai_example/` for a worked example, or visit the [Kaitai Struct Documentation](https://doc.kaitai.io/user_guide.html).
1818

19-
* Kaitai also has an interactive [webIDE](https://ide.kaitai.io/) with examples of many popular data/file formats.
19+
* Kaitai also has an interactive [webIDE](https://ide.kaitai.io/) with examples of many popular data/file formats. You can also import your own .ksy schema format and corresponding data file into the tool.
20+
21+
* The [Kaitai Stream API](http://doc.kaitai.io/stream_api.html) is a critical piece of the puzzle if you're actually trying to incorporate the code generated by Kaitai into a project. These runtime libraries exist for all languages supported by Kaitai and are essentially a wrapper around the languages native I/O libraries. For compiled languages and depending on your compilation environment you may need to include the appropriate header file in your generated code. For example, in C++ you will need to add a line reading `#include kaitaistream.h` to the header file you generated for your format. Interpreted languages such as Python and Ruby require the installation of the kaitaistream package.
2022

2123

2224
## Sample Structures for Binary Data

0 commit comments

Comments
 (0)