From c4e9b57b7edc0b1145c2036214dc82ef7e21a1dc Mon Sep 17 00:00:00 2001 From: Tore Niermann Date: Wed, 8 Nov 2017 16:37:01 +0100 Subject: [PATCH] Update documentation and git ignore file --- .gitignore | 5 +++++ BUILD.txt | 30 ++++++++++++++++++++++++++++++ README.txt | 44 +++++++++++++------------------------------- 3 files changed, 48 insertions(+), 31 deletions(-) create mode 100644 .gitignore create mode 100644 BUILD.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4598f02 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +*.ncb +*.sln +*.suo +*.user +Release diff --git a/BUILD.txt b/BUILD.txt new file mode 100644 index 0000000..6907296 --- /dev/null +++ b/BUILD.txt @@ -0,0 +1,30 @@ +Build instructions +====================================================================== + + For the DMSDKs contact Gatan or look on their website www.gatan.com. + + It is assumed, that the DMSDKs and their dependencies (e.g. boost) + were already properly installed. + + GMS-2.X: + * Open vc2008/fftpack.vcproj with Visual Studio 2008 + * Add your DMSDK include and library directories to the VC++ Directories + in Visual Studio (in Tools/Options/Projects and Solutions/VC++ Directories). The + DMSDK is usally installed to C:\ProgramData\Gatan\DMSDK + * Build the Release build + * You should find your plugin as vc2008/Release/fftpack_GMS2X_x86.dll + + GMS-1.X: + * Open vc2003/fftpack.vcproj with Visual Studio 2003 + * Add your DMSDK include and library directories to the VC++ Directories + in Visual Studio (in Tools/Options/Projects/VC++ Directories). + * Build the Release build + * You should find your plugin as vc2003/Release/fftpack_GMS1X.dll + +Documentation +====================================================================== + +The documentation uses the Sphinx (sphinx.pocoo.org) documentation system, +which in turn requires a working Python (www.python.org) installation. +To build the documentation simply go into the documentation subdirectory +(doc/) and invoke the sphinx system (e.g. by calling make.bat html) diff --git a/README.txt b/README.txt index 1d1df9a..8b72aed 100644 --- a/README.txt +++ b/README.txt @@ -1,4 +1,4 @@ -1. Introduction +Introduction ====================================================================== The plugin contains FFT functions for Digital Micrograph: @@ -9,30 +9,7 @@ The plugin contains FFT functions for Digital Micrograph: The functions are based on the fftpack.c implementation provided with the numpy package (see www.numpy.org). -2. Building -====================================================================== - - For the DMSDKs contact Gatan or look on their website www.gatan.com. - - It is assumed, that the DMSDKs and their dependencies (e.g. boost) - were already properly installed. - - GMS-2.X: - * Open vc2008/fftpack.vcproj with Visual Studio 2008 - * Add your DMSDK include and library directories to the VC++ Directories - in Visual Studio (in Tools/Options/Projects and Solutions/VC++ Directories). The - DMSDK is usally installed to C:\ProgramData\Gatan\DMSDK - * Build the Release build - * You should find your plugin as vc2008/Release/fftpack_GMS2X_x86.dll - - GMS-1.X: - * Open vc2003/fftpack.vcproj with Visual Studio 2003 - * Add your DMSDK include and library directories to the VC++ Directories - in Visual Studio (in Tools/Options/Projects/VC++ Directories). - * Build the Release build - * You should find your plugin as vc2003/Release/fftpack_GMS1X.dll - -3. Install +Install ====================================================================== Simply copy the fftpack.dll to the plugin directory of your Digital @@ -41,10 +18,15 @@ Micrograph installation. By default these are for GMS-2.X: and for GMS-1.X: c:\Program Files\Gatan\DigitalMicrograph\Plugins -4. Documentation -====================================================================== +Disclaimer +========== + +All product and company names are trademarks or registered trademarks of +their respective holders. Use of them does not imply any affiliation +with or endorsement by them. + +Author & Contact +================ -The documentation uses the Sphinx (sphinx.pocoo.org) documentation system, -which in turn requires a working Python (www.python.org) installation. -To build the documentation simply go into the documentation subdirectory -(doc/) and invoke the sphinx system (e.g. by calling make.bat html) +The plugin was written by Tore Niermann. +Email: niermann at physik.tu-berlin.de