Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding additional languages to the readme. Not updating samples #840

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Adding additional languages to the readme. Not updating samples #840

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,16 +155,22 @@ more insights.
## Supported languages

Official Kaitai Struct [compiler] now supports compiling `.ksy` into
source modules for the following languages:
source modules for [the following languages](https://github.com/kaitai-io?q=runtime&type=&language=):

* C++
* C#
* Go
* Java
* JavaScript
* TypeScript
* Lua
* Perl
* Nim
* PHP
* Python
* Ruby
* Swift
* Rust
Comment on lines +165 to +173
Copy link
Member

@generalmimon generalmimon Dec 18, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Official Kaitai Struct compiler now supports compiling .ksy into source modules for the following languages:

TypeScript, Swift and Rust shouldn't be there, because the KS compiler doesn't support them yet (see kaitai-struct-compiler --help):

  -t, --target <language>  target languages (graphviz, csharp, rust, all, perl, java, go, cpp_stl, php, lua, python, nim, html, ruby, construct, javascript)

Support of these targets in Kaitai Struct has not gone too far - work started just on their runtime libraries and even these are often incomplete or dysfunctional.

I suggest using the same list as on the kaitai.io homepage (section Language-neutral), preferably keeping the wrench icons to show that Go and Nim are in the state of work-in-progress (e.g. using some emoji: https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md). This list should be up to date.


## Downloading and installing

Expand All @@ -184,13 +190,18 @@ consitute Kaitai Struct suite. They are:
* Runtime libraries
* [kaitai_struct_cpp_stl_runtime](https://github.com/kaitai-io/kaitai_struct_cpp_stl_runtime) — for C++/STL
* [kaitai_struct_csharp_runtime](https://github.com/kaitai-io/kaitai_struct_csharp_runtime) — for C#
* [kaitai_struct_go_runtime](https://github.com/kaitai-io/kaitai_struct_go_runtime) — for Go
* [kaitai_struct_java_runtime](https://github.com/kaitai-io/kaitai_struct_java_runtime) — for Java
* [kaitai_struct_javascript_runtime](https://github.com/kaitai-io/kaitai_struct_javascript_runtime) — for JavaScript
* [kaitai_struct_typescript_runtime](https://github.com/kaitai-io/kaitai_struct_typescript_runtime) — for TypeScript
* [kaitai_struct_nim_runtime](https://github.com/kaitai-io/kaitai_struct_nim_runtime) — for Nim
* [kaitai_struct_lua_runtime](https://github.com/kaitai-io/kaitai_struct_lua_runtime) — for Lua
* [kaitai_struct_perl_runtime](https://github.com/kaitai-io/kaitai_struct_perl_runtime) — for Perl
* [kaitai_struct_php_runtime](https://github.com/kaitai-io/kaitai_struct_php_runtime) — for PHP
* [kaitai_struct_python_runtime](https://github.com/kaitai-io/kaitai_struct_python_runtime) — for Python
* [kaitai_struct_ruby_runtime](https://github.com/kaitai-io/kaitai_struct_ruby_runtime) — for Ruby
* [kaitai_struct_swift_runtime](https://github.com/kaitai-io/kaitai_struct_swift_runtime) — for Swift
* [kaitai_struct_rust_runtime](https://github.com/kaitai-io/kaitai_struct_rust_runtime) — for Rust
* [kaitai_struct_formats](https://github.com/kaitai-io/kaitai_struct_formats)
— library of widely used formats and binary structures described as
`.ksy` files
Expand Down