Skip to content

Commit

Permalink
Merge pull request #209 from egregorimar/fix-specs-docs
Browse files Browse the repository at this point in the history
replace asterix2json with asterixjson2xml in documentation
  • Loading branch information
dsalantic committed Dec 4, 2023
2 parents a6def69 + 2fdc8ad commit 3267eaf
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions asterix-specs-converter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ using a script from this directory.
In case of problems in asterix definitions, users of this project are
encouraged to report problems upstream.

## Running `asterix2json.py` script
## Running `asterixjson2xml.py` script

> **_NOTE:_** `asterix2json.py` script requires `python36` or higher.
> **_NOTE:_** `asterixjson2xml.py` script requires `python36` or higher.
### Basic conversion example:

Expand All @@ -49,16 +49,16 @@ python3 --version
curl https://zoranbosnjak.github.io/asterix-specs/specs/cat062/cats/cat1.18/definition.json > input.json

# convert json to xml
python3 asterix2json.py < input.json > output.xml
python3 asterixjson2xml.py < input.json > output.xml

# or directly
curl https://zoranbosnjak.github.io/asterix-specs/specs/cat062/cats/cat1.18/definition.json | python3 asterix2json.py
curl https://zoranbosnjak.github.io/asterix-specs/specs/cat062/cats/cat1.18/definition.json | python3 asterixjson2xml.py
```

### Combine CAT+REF definition to a single xml:

```bash
python3 asterix2json.py --cat category.json --ref ref.json --outfile out.xml
python3 asterixjson2xml.py --cat category.json --ref ref.json --outfile out.xml
```
## Running `update-specs.py` script
This scripts autimatically reads latest Asterix specifications from
Expand All @@ -77,7 +77,7 @@ python3 update-specs.py
- commit new/changed `.xml` file to this repository;

> **_NOTE:_** If the resulting `.xml` file in not as expected, check/modify
the `asterix2json.py` script.
the `asterixjson2xml.py` script.

> **_NOTE:_** Do not manually edit converted `.xml` files if possible.
Expand Down

0 comments on commit 3267eaf

Please sign in to comment.