summaryrefslogtreecommitdiff
path: root/erts/lib_src/yielding_c_fun/test/examples/sha256_erlang_nif/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'erts/lib_src/yielding_c_fun/test/examples/sha256_erlang_nif/README.md')
-rw-r--r--erts/lib_src/yielding_c_fun/test/examples/sha256_erlang_nif/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/erts/lib_src/yielding_c_fun/test/examples/sha256_erlang_nif/README.md b/erts/lib_src/yielding_c_fun/test/examples/sha256_erlang_nif/README.md
new file mode 100644
index 0000000000..ba579880b3
--- /dev/null
+++ b/erts/lib_src/yielding_c_fun/test/examples/sha256_erlang_nif/README.md
@@ -0,0 +1,23 @@
+sha256_nif
+=====
+
+An OTP library that illustrates how one can implement a yielding
+Erlang NIF API with the help of Yielding C Fun.
+
+Build
+-----
+
+ $ rebar3 compile
+
+or
+
+ $ make
+
+Test
+----
+
+ $ rebar3 ct
+
+or
+
+ $ make test \ No newline at end of file