diff --git a/README.md b/README.md index 1789de5..639379e 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,15 @@ HyperCanny project ================== -Doing Canny edge detection in higher dimensions. This doesn't do anything yet. - +Doing Canny edge detection in higher dimensions. Requirements ------------ -HyperCanny is written in C++14, OpenCL, using NetCDF as data container. Dependencies: +HyperCanny is written in C++17, using NetCDF as data container. Dependencies: -- GCC >= 5 or CLANG >= 3.4 +- GCC >= 6 or CLANG >= 4.0 - [NetCDF-cxx4](https://github.com/Unidata/netcdf-cxx4) -- [OpenCL](https://www.khronos.org/opencl/) -- [FFTW3](http://www.fftw.org/) -- [libpng](http://www.libpng.org/pub/png/libpng.html) Building -------- @@ -32,6 +28,15 @@ To run the unit tests, follow up with `ninja test` in the `build` directory. Alternatively, there is a `Makefile` that runs these commands for you; this also allows for easier integration with some IDEs. +Python module +------------- + +The code also compiles into a Python module. From the project root run: + +```bash +> pip install . +``` + Testing / Development ---------------------