1 # Welcome to the JDK!
 3 For build instructions please see the
 4 [online documentation](https://openjdk.java.net/groups/build/doc/building.html),
 5 or either of these files:
 7 - [doc/building.html](doc/building.html) (html version)
 8 - [doc/building.md](doc/building.md) (markdown version)
10 See <https://openjdk.java.net/> for more information about
11 the OpenJDK Community and the JDK.
13 ---
14 About Project Panama
15 ===================
16 This repository contains changes which aim at improving the interoperability between the Java programming language and native libraries, which is one of the main goals of Project Panama. More information can be found at: https://openjdk.java.net/projects/panama/
18 The Project Panama JBS dashboard can be found at: https://bugs.openjdk.java.net/Dashboard.jspa?selectPageId=18412
20 Early acccess (EA) binary snapshots can be found at: http://jdk.java.net/panama/
22 About the panama-foreign repository
23 ===================
24 This repository houses two main branches:
25 - **foreign-memaccess+abi**: Contains the developement of both the foreign memory access API ([JEP 393](https://openjdk.java.net/jeps/393)) and the foreign linker API ([JEP 389](https://openjdk.java.net/jeps/389)). The former can be used to interact with different kinds of memory resources, including so-called off-heap or native memory. The latter can be used to call native code in a .dll/.so/.dylib, or to create a native function pointer to a Java method which can be passed to code in a native library. More information on how to use the memory access API and foreign linker API can be found [here](doc/panama_memaccess.md) and [here](doc/panama_ffi.md), respectively.
26 - **foreign-jextract**: Contains the development of an API to parse native headers, which can be used to create an abstract representation (declarations) from a C header file. This branch also provides an accompanying extraction tool (jextract), which is built on top of the API, and can be used to generate Java bindings to access functions and/or structs in a native library described by a given header file. More information on how to use the jextract tool can be found [here](doc/panama_jextract.md).
28 The foreign-jextract branch depends on the foreign-memaccess+abi branch, which in turn depends on the master branch (which is kept periodically in sync with jdk/jdk). As such, the foreign-jextract branch is the most complete of the three and therefore the default branch of this repository.
30 Building notes
31 ===================
32 Jextract requires [LLVM 9.x](https://releases.llvm.org/download.html) as a dependency. So, to build the foreign-jextract branch, the flag `--with-libclang=/path/to/llvm/root` must be supplied when generating a build configuration. Please see [doc/building.md](doc/building.md) for general building instructions.