Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jhidding authored Nov 16, 2017
1 parent 6a79b79 commit af9256e
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------
Expand All @@ -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
---------------------

Expand Down

0 comments on commit af9256e

Please sign in to comment.