diff --git a/README.md b/README.md index 31013dc8..10c3c961 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,25 @@ with operator overloading. In honour of Marian Rejewski, a Polish mathematician and cryptologist. + +Installation +------------ + +Requirements: + +* g++ with C++14 +* CUDA and CuDNN + +Exporting some paths for CuDNN may be required (put it, for example, in your `.bashrc` file): + + export PATH=$PATH:$HOME/.local/bin:/usr/local/cuda/bin + export LIBRARY_PATH=$LIBRARY_PATH:/usr/local/cuda/lib64:/usr/local/cudnn-5/lib64 + export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/cuda/lib64:/usr/local/cudnn-5/lib64 + export CPATH=$CPATH:/usr/local/cudnn-5/include + +Compilation with `cmake > 3.5`: + + mkdir build + cmake .. + make -j +