Skip to content
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ and back to help with poking at the binary.

## HTML cards

Prebuilt version of the HTML data is available at
Prebuilt version of the HTML data is available at
https://katajakasa.fi/projects/openomf/cards/

## Installation
Expand All @@ -15,11 +15,17 @@ https://katajakasa.fi/projects/openomf/cards/
3. Activate the virtualenv, eg. `poetry shell`
4. Run! eg. `python -m omftools.cli.af_compile -h`

Or with pyenv:
1. `pyenv install 3.11.4`
2. `pyenv virtualenv 3.11.4 pyomftools-3.11`
3. `pyenv local pyomftools-3.11`
4. ...

## How to ...

### Generate the taglist.c

1. Do the installation step above
2. Make sure the tag `omftools/resources/tags.csv` is up-to-date.
3. Run `poetry run python -m omftools.cli.tags -i omftools/resources/tags.csv taglist.c`
4. Copy the generated `taglist.c` as required.
4. Copy the generated `taglist.c` as required.
Loading