You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Using Kaitai Struct in a program requires additional downloads beyond what's available from clicking the "download" link, but this is not made clear, and there are no obvious links to them.
Steps to reproduce:
Click the "download" link.
Download and install the "universal .zip" package or the "Linux .deb" package (or, presumably, the Windows MSI installer).
Use the Kaitai Struct compiler to generate code.
Expected result:
You now have everything you need to use Kaitai Struct in your program.
Actual result:
You still need to download the appropriate runtime. If there are any download links for the runtimes on the site, I've been unable to find them.
The text was updated successfully, but these errors were encountered:
Yes, you're right. Our website/documentation is generally not very good at communicating this to the users. I've added some instructions in this regard to the individual format pages at formats.kaitai.io (see kaitai-io/kaitai_struct#571), but that was only for the most popular languages. And it obviously deserves more attention on the homepage too.
but this is not made clear, and there are no obvious links to them.
Typically, using formats described in KS in your project involves the following steps:
Describe the format — i.e. create a .ksy file
Use a visualizer to debug the format and ensure that it parses data properly
Compile the .ksy file into a target language source file and include that file into your project
Add the KS runtime library for your particular language into your project (don’t worry, it’s small and it’s there mostly to ensure readability of generated code)
Use the generated class(es) to parse your binary file or stream and access its components
but I agree this is not very clear or sufficient, and it's not an excuse. I'm aware that this is an issue. At least the homepage deserves a bit of rework to address it.
Most users appear to ultimately figure out that they need the runtime library as well, but I'm not entirely sure how they do that, because it's indeed not very well documented.
Using Kaitai Struct in a program requires additional downloads beyond what's available from clicking the "download" link, but this is not made clear, and there are no obvious links to them.
Steps to reproduce:
Expected result:
You now have everything you need to use Kaitai Struct in your program.
Actual result:
You still need to download the appropriate runtime. If there are any download links for the runtimes on the site, I've been unable to find them.
The text was updated successfully, but these errors were encountered: