From 61d0574c5c447f7de02e24a36d045701c092c19e Mon Sep 17 00:00:00 2001 From: Karl Tauber Date: Tue, 9 Mar 2021 19:08:53 +0100 Subject: [PATCH] Native window decorations: added READMEs --- flatlaf-natives/README.md | 5 +++++ flatlaf-natives/flatlaf-natives-jna/README.md | 10 ++++++++++ .../flatlaf-natives-windows/README.md | 16 ++++++++++++++++ 3 files changed, 31 insertions(+) create mode 100644 flatlaf-natives/README.md create mode 100644 flatlaf-natives/flatlaf-natives-jna/README.md create mode 100644 flatlaf-natives/flatlaf-natives-windows/README.md diff --git a/flatlaf-natives/README.md b/flatlaf-natives/README.md new file mode 100644 index 00000000..15e8acb8 --- /dev/null +++ b/flatlaf-natives/README.md @@ -0,0 +1,5 @@ +FlatLaf Native Libraries +======================== + +- [Windows 10 Native Library](flatlaf-natives-windows) +- [Natives using JNA](flatlaf-natives-jna) (for development only) diff --git a/flatlaf-natives/flatlaf-natives-jna/README.md b/flatlaf-natives/flatlaf-natives-jna/README.md new file mode 100644 index 00000000..09b357ca --- /dev/null +++ b/flatlaf-natives/flatlaf-natives-jna/README.md @@ -0,0 +1,10 @@ +FlatLaf Natives using JNA +========================= + +This sub-project contains source code that uses +[JNA](https://github.com/java-native-access/jna) to access native operating +system API. + +**Note:** Code in this sub-project is **not used** in FlatLaf libraries. It was +used to develop/test usage of some native operating system API in Java (with the +help of JNA) and was then converted to C++. diff --git a/flatlaf-natives/flatlaf-natives-windows/README.md b/flatlaf-natives/flatlaf-natives-windows/README.md new file mode 100644 index 00000000..14505147 --- /dev/null +++ b/flatlaf-natives/flatlaf-natives-windows/README.md @@ -0,0 +1,16 @@ +FlatLaf Windows 10 Native Library +================================= + +This sub-project contains the source code for the FlatLaf Windows 10 native +library (DLL). + +The native library can be built only on Windows and requires a C++ compiler. +Tested only with Microsoft Visual C++ 2019 (comes with Visual Studio 2019). + +To be able to build FlatLaf on any platform, and without C++ compiler, the +pre-built DLL is checked into Git at +`flatlaf-core/src/main/resources/com/formdev/flatlaf/natives/flatlaf-windows-x86_64.dll`. + +This DLL was built on a GitHub server with the help of GitHub Actions. See: +[Native Libraries](https://github.com/JFormDesigner/FlatLaf/actions/workflows/natives.yml) +workflow. Then the produced Artifacts ZIP was downloaded and checked into Git. \ No newline at end of file