From da4ea25caf9394963639f65c38ddcc01c7de522c Mon Sep 17 00:00:00 2001 From: "Kai T. Ohlhus" Date: Sun, 6 Sep 2020 10:11:14 +0900 Subject: [PATCH] README.md: update. --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0d813cb..ed0b34a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,14 @@ # pkg-example -A minimal [GNU Octave](https://www.octave.org) -[package example](https://octave.org/doc/latest/Creating-Packages.html). +A minimal [package example](https://octave.org/doc/latest/Creating-Packages.html) +for [GNU Octave](https://www.octave.org). Contained examples are: + +- `hello_world.m`: Octave/Matlab code +- `fortran_demo.cc` / `fortran_my_ddot.f`: FORTRAN code + ([BLAS DDOT](https://github.com/Reference-LAPACK/lapack/blob/master/BLAS/SRC/ddot.f)) + called by the oct-interface +- `oct_demo.cc`: C++ code called by the oct-interface +- `mex_demo.cc`: C code called by the mex-interface This package serves as template. Installing it is of little use. In the following, we describe the Octave package development,