diff --git a/README.md b/README.md index 8d1911930af5db6f0bd30117707d6ddcb6335c8e..c942e5b162fae2c82d3717614611ba8e2d38f6b3 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,8 @@ Structure tensor in 2D and 3D. -Code for computation of the structure tensor and the notebooks with the examples of use. +Contains modules with the code that computes structure tensors in 2D and 3D +(the files st2d.py and st3d.py) and also a few helping functions for easier +visualization. The examples for the use of modules are in the fiels +st2d\_examples.py and st3d\_examples.py. The two jupyter notebooks contain +more-or-less the same examples. Small pieces of data are provided.