From 922c01bf623d1eacc5c27fc36a152cfccb14173f Mon Sep 17 00:00:00 2001
From: J08nY
Date: Tue, 17 Sep 2019 19:32:46 +0200
Subject: Add info on developing ECTester standalone modules to docs.

---
 docs/DEVELOPING.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 docs/DEVELOPING.md

(limited to 'docs')

diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md
new file mode 100644
index 0000000..863361b
--- /dev/null
+++ b/docs/DEVELOPING.md
@@ -0,0 +1,14 @@
+# Developing ECTester
+
+This document describes some development guidelines and how-tos regarding
+developing the ECTester tool itself.
+
+## Developing ECTester standalone modules
+
+ - Create Java classes inheriting Native{ECPrivateKey,ECPublicKey,KeyPairGeneratorSpi,KeyAgreementSpi,SignatureSpi}.
+ - Add those classes to `build-standalone.xml` header generation.
+ - Generate `native.h` headers for new classes using `build-standalone.xml`.
+ - Create module file (C/C++) in `cz/crcs/ectester/standalone/libs/jni`, and add it to the Makefile.
+ - Implement the required JNI functions, look at existing modules for what is expected, what the contract
+ of the function is, use the `native_timing_*` functions around points that should be measurable.
+ - Compile and run ECTester using your new module.
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2