Skip to content

Commit

Permalink
doc: open on colab
Browse files Browse the repository at this point in the history
  • Loading branch information
zonca committed Dec 9, 2024
1 parent 2a3ab93 commit 9528053
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
"source": [
"# Katai struct awkward runtime\n",
"\n",
"<a target=\"_blank\" href=\"https://colab.research.google.com/github/det-lab/kaitai_struct_awkward_runtime/blob/main/docs/index.ipynb\">\n",
" <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/>\n",
"</a>\n",
"\n",
"This is a runtime for the [Kaitai Struct](https://kaitai.io/) compiler that generates code for the [Awkward Array](https://awkward-array.org/) library.\n",
"\n",
"Kaitai Struct is a declarative language used to describe binary data structures, and the Kaitai Struct compiler generates code in various languages to parse these structures. This project generates C++ code which reads the input data into Awkward Arrays, leveraging the flexibility and performance of the Awkward Array library.\n",
Expand All @@ -17,6 +21,9 @@
"\n",
"This has been currently tested only on Ubuntu both natively and under the Windows Subsystem for Linux on Windows Server 2022.\n",
"\n",
"It is also possible to run the install and example execution on Google Colab, click on the \n",
"[Open on Colab badge](https://colab.research.google.com/github/det-lab/kaitai_struct_awkward_runtime/blob/main/docs/index.ipynb) above.\n",
"\n",
"### Install the Kaitai compiler\n",
"\n",
"See the [Kaitai docs](https://kaitai.io/#download), at the moment:"
Expand Down

0 comments on commit 9528053

Please sign in to comment.