p≡p for Java
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

66 lines
1.7 KiB

4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
4 years ago
  1. # p≡p JNI Adapter
  2. Please find the complete build instructions here:
  3. https://dev.pep.foundation/Common%20Adapter%20Documentation/Adapter_Build_Instructions
  4. ## Build Result
  5. The binary package resulting from the build will be located under `./dist`.
  6. It merely contains:
  7. * pEp.jar - The java library
  8. * libpEpJNI.dylib - The dynamically linkable native library
  9. * libpEpJNI.a - The statically linkable native library
  10. ## Build Configuration
  11. The build configuration file is called `local.conf`.
  12. Use the file `local.conf.example` as a template.
  13. ```bash
  14. cp local.conf.example local.conf
  15. ```
  16. Then, tweak it to your needs.
  17. ## Make Targets
  18. The default make target is `compile`.
  19. ### Build
  20. * `make compile`
  21. Builds the whole adapter under `./build`.
  22. The complete distribution ready adapter will be in `./dist`.
  23. ### Test
  24. * `make test`
  25. Builds the complete test-suite under `./test`.
  26. ### Clean
  27. * `make clean`
  28. Deletes all the derived objects of the adapter build in `./build` and `./dist`.
  29. Also invokes `make clean` which cleans the whole test-suite.
  30. Does not remove the generated API doc.
  31. * `make clean-doc`
  32. Removes all the generated API doc.
  33. * `make clean-all`
  34. Equals `make clean` and `make clean-doc`
  35. ### Doc
  36. In order to generate the API doc you need to have doxygen installed on your system.
  37. * `make doc`
  38. Generates Java and C++ API doc.
  39. * `make doc-cxx`
  40. Generates the API doc for the C++ part of the adapter.
  41. * `make doc-java`
  42. Generates the API doc for the Java part of the adapter.
  43. ### Install
  44. * `make install`
  45. Installs the files under `./dist` under $PREFIX (local.conf)
  46. * `make uninstall`
  47. Removes all the filenames under `./dist` from $PREFIX (local.conf)