Files
blis/examples/oapi/README
Field G. Van Zee 0f491e994a Allow lesser Makefiles to reference installed BLIS.
Details:
- Updated the build system so that "lesser" Makefiles, such as those in
  belonging to example code or the testsuite, may be run even if the
  directory is orphaned from the original build tree. This allows a
  user to configure, compile, and install BLIS, delete the build tree
  (that is, the source distribution, or the build directory for out-
  of-tree builds) and then compile example or testsuite code and link
  against the installed copy of BLIS (provided the example or testsuite
  directory was preserved or obtained from another source). The only
  requirement is that make be invoked while setting the
  BLIS_INSTALL_PATH variable to the same installation prefix used when
  BLIS was configured. The easiest syntax is:

    make BLIS_INSTALL_PATH=/install/prefix

  though it's also permissible to set BLIS_INSTALL_PATH as an
  environment variable prior to running 'make'.
- Updated all lesser Makefiles to implement the new aforementioned build
  behavior.
- Relocated check-blastest.sh and check-blistest.sh from build to
  blastest and testsuite, respectively, so that if those directories are
  copied elsewhere the user can still run 'make check' locally.
- Updated docs/Testsuite.md with language that mentions this new option
  of building/linking against an installed copy of BLIS.
2018-08-25 20:12:36 -05:00

39 lines
1.6 KiB
Plaintext

BLIS object API examples
------------------------
This directory contains several files, each containing various pieces of
example code that demonstrate core functionality of the object API in BLIS.
These example files should be thought of collectively like a tutorial, and
therefore it is recommended to start from the beginning (the file that
starts in '00').
You can build all of the examples by simply running 'make' from this
directory. (You can also run 'make clean'.) The makefile assumes that
you've already configured and built (but not necessarily installed) BLIS
two directories up, in "../..". If you have already installed BLIS to
some permanent directory, you may refer to that installation by setting
the environment variable BLIS_INSTALL_PATH prior to running make:
export BLIS_INSTALL_PATH=/usr/local; make
or by setting the same variable as part of the make command:
make BLIS_INSTALL_PATH=/usr/local
Once the executable files have been built, we recommend reading the code in
one terminal window alongside the executable output in another. This will
help you see the effects of each section of code.
This tutorial is not exhaustive or complete; several object API functions
were omitted (mostly for brevity's sake) and thus more examples could be
written. If you've found object functionality in BLIS and are unsure how to
use it, or if you are unsure of what additional functionality is present in
BLIS, please feel free to join and then start a discussion on the blis-devel
mailing list [1].
Thanks for your interest in BLIS!
[1] https://groups.google.com/d/forum/blis-devel