diff --git a/README.md b/README.md index 23b34ee..89af8eb 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,16 @@ ## Important note -Please, note that this project is currently under construction! Soon, we will work on -a nice description of AFM_thumbs.py and also of its installation. Please, -be patient. -- Clemens Barth (2022-04-20) +Note that the pages here are currently under construction! Soon, we will will have a first version, including an extensive description of `AFM_thumbs.py`. Please, be patient. -- Clemens Barth (2022-04-20) # AFM_thumbs.py ## Introduction -The python program AFM_thumbs creates a pdf file, which shows all SPM +The python program `AFM_thumbs.py` creates a pdf file, which shows all SPM (Scanning Probe Microscopy: like AFM, STM, KPFM, etc.) images and relevant -data stored in a directory. In first place, AFM_thumbs is interesting for -scientists, who would like to obtain an overview of their SPM data. +spectroscopy data stored in a directory. In first place, `AFM_thumbs.py` +is interesting for scientists, who would like to obtain an overview of +their SPM data. ## Supported SPM data