Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
* add explanation of naming

* add instructions for testing

* add warning to use only tagged release commits
  • Loading branch information
dirkboye authored and kalcutter committed Mar 9, 2021
1 parent 6df1348 commit ab337cf
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@ Neggia
XDS plugin that reads hdf5 files written by Dectris Eiger Detectors.
Please note that a recent version of XDS (Version June 1, 2017 or later) is required for this to work.

## Build
## Naming

Neggia - mountain pass in the Italian-speaking part of Switzerland pronounced "neh-jah".
Wikipedia: https://en.wikipedia.org/wiki/Alpe_di_Neggia

## Build & Test

Please use only tagged release commits for your production environment.
See https://github.com/dectris/neggia/releases

### Prerequisites
* gcc-4.8 or higher
Expand All @@ -18,10 +26,18 @@ Please note that a recent version of XDS (Version June 1, 2017 or later) is requ

### Building
Use cmake or cmake3, depending on what your cmake version 3 executable is called.
* git submodule update --init
* mkdir build
* cd build
* cmake ..
* make
* cmake .. -DCMAKE_BUILD_TYPE=Release
* cmake --build .

The plugin file is found in `build/src/dectris/neggia/plugin/dectris-neggia.so`

The plugin file is found in build/src/dectris/neggia/plugin/dectris-neggia.so
### Testing
Use cmake or cmake3, depending on what your cmake version 3 executable is called.
* git submodule update --init
* mkdir build
* cd build
* cmake .. -DBUILD_TESTING=ON -DCMAKE_BUILD_TYPE=Debug
* cmake --build .
* ctest --output-on-failure

0 comments on commit ab337cf

Please sign in to comment.