Skip to content

Commit 0778417

Browse files
authored
Updated README to be actually useful..
Replaced the old CMakeShell README
1 parent aebf835 commit 0778417

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ implementatins on QDP++. To build this code it is
77
recommended to perform a recursive checkout of the
88
repository:
99

10-
[`github.com;bjoo/SyCLDslashWorkspace.git`][https://github.com/bjoo/SyCLDslashWorkspace,git]
10+
[`github.com:bjoo/SyCLDslashWorkspace.git`](https://github.com/bjoo/SyCLDslashWorkspace.git)
1111

1212
which contains QDP++ and its dependencies
1313

@@ -19,7 +19,7 @@ Checking out this repository
1919

2020
It is highly recommended that this library be checked out using
2121
the `--recursive` option to Git so that the `googletest` submodule
22-
is checked out. Alternatively consider checking out [`SyCLDslashWorkspace`][https://github.com/bjoo/SyCLDslashWorkspace,git].
22+
is checked out. Alternatively consider checking out [`SyCLDslashWorkspace`](https://github.com/bjoo/SyCLDslashWorkspace.git).
2323

2424

2525

@@ -32,11 +32,11 @@ Useful CMake options are:
3232
* `-DQDPXX_DIR=<qdp-install-location>/share` - points to the `share` directory of an installation of QDP++ which contains a `FindQDPXX.cmake` file.
3333

3434
* `-DMG_FORTRANLIKE_COMPLEX=ON` enables (RIRIRIRI) storage for complex numbers in
35-
vectors. Turning it to 'OFF'
35+
vectors. Turning it to 'OFF' selects a more vector oriented storage order of (RRRR...)(IIII...)
3636

37-
* `-DMG_USE_NEIGHBOR_TABLE=OFF` (if set to 'ON` would use a neighbour table taht is actualy a lookup
38-
table. Currently this is set to OFF as that option is not currently supported, neighbor indices are
39-
explicitly computed.
37+
* `-DMG_USE_NEIGHBOR_TABLE=OFF` (if set to 'ON` would use a neighbour table that is actualy a lookup
38+
table. This option is not currently implemented properly, neighbor indices are
39+
explicitly computed, and this option should remain 'OFF')
4040

4141
* `-DMG_USE_LAYOUT_LEFT=OFF` ( if set to `ON` selects left index fastest indexing for View objects, if
4242
set to `OFF` uses right fastest indexing, following Kokkos. )

0 commit comments

Comments
 (0)