Skip to content

Commit

Permalink
Update documentation and git ignore file
Browse files Browse the repository at this point in the history
  • Loading branch information
Tore Niermann committed Nov 8, 2017
1 parent 8527b94 commit c4e9b57
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 31 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*.ncb
*.sln
*.suo
*.user
Release
30 changes: 30 additions & 0 deletions BUILD.txt
Original file line number Diff line number Diff line change
@@ -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)
44 changes: 13 additions & 31 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. Introduction
Introduction
======================================================================

The plugin contains FFT functions for Digital Micrograph:
Expand All @@ -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
Expand All @@ -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

0 comments on commit c4e9b57

Please sign in to comment.