Skip to content

Commit

Permalink
revert docs install now Release is default cmake build
Browse files Browse the repository at this point in the history
  • Loading branch information
ahbarnett committed Jul 16, 2024
1 parent 25096f8 commit cce4386
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,14 @@ The basic quick download, building, and test is then:
cd finufft
mkdir build
cd build
cmake .. -D FINUFFT_BUILD_TESTS=ON -D CMAKE_BUILD_TYPE=Release --install-prefix /path/to/install
cmake .. -D FINUFFT_BUILD_TESTS=ON --install-prefix /path/to/install
cmake --build . -j
ctest
cmake --install .
.. note::

Note: `Release` here is essential to get the best performing version. Also, if you don't supply `--install-prefix`, it will default to ``/usr/local`` on most systems. If you don't
have root access, you must supply a prefix you can write to such as ``$HOME/local``. Now...
If you don't supply `--install-prefix`, it will default to ``/usr/local`` on most systems. If you don't have root access, you must supply a prefix you can write to such as ``$HOME/local``.

In ``build``, this creates ``libfinufft_static.a`` and ``libfinufft.so``, and runs a test that should take a
few seconds and report ``100% tests passed, 0 tests failed out of 17``. To use the library, link against
Expand Down

0 comments on commit cce4386

Please sign in to comment.