summaryrefslogtreecommitdiffstats
path: root/js/src/zydis/README.md
blob: 3336a49cbd8f122fe45628a7bd14f66f6d6e3442 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Zydis disassembler

Zydis x64/x86 disassembler imported from github, see
https://github.com/zyantific/zydis and https://github.com/zyantific/zycore-c.

Zydis is MIT licensed code, see Zydis/LICENSE and Zycore/LICENSE.

Sources here were taken from the tag/revision of Zydis that is recorded in the
file imported-revision.txt.

The file hierarchy of Zydis+Zycore has been flattened and processed as described
in the script update.sh.

## Integrating new versions of Zydis

The procedure for pulling a new version is encoded in the script update.sh,
which is to be run from the parent directory of zydis, ie, from js/src/.  It
will create a new zydis directory and pull new files from github into it,
leaving the old zydis directory as zydis_old.

It's not a given that the script will work out of the box for new versions of
zydis or that the resulting files will build as-is.  Buyer beware.