Skip to content

Commit

Permalink
doc: typo and wget
Browse files Browse the repository at this point in the history
  • Loading branch information
zonca committed Dec 4, 2024
1 parent 05a1e3f commit 2283809
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,18 @@ sudo apt-get install --reinstall ./kaitai-struct-compiler_0.10_all.deb
### Install the runtime

```bash
pip install kaitai-awkward
pip install awkward-kaitai
```

## Usage

First we need a test schema and a test file, for example we can take `animal.ksy` and `animal.raw` from the [Kaitai Awkward Struct examples](https://github.com/det-lab/kaitai_struct_awkward_runtime/tree/main/example_data)

```bash
wget https://github.com/det-lab/kaitai_struct_awkward_runtime/raw/refs/heads/main/example_data/schemas/animal.ksy
wget https://github.com/det-lab/kaitai_struct_awkward_runtime/raw/refs/heads/main/example_data/data/animal.raw
```

Then we first compile the schema into C++ sources:

```bash
Expand Down

0 comments on commit 2283809

Please sign in to comment.