Skip to content

Commit

Permalink
Update documentation for the Natlink and DNS engine back-end
Browse files Browse the repository at this point in the history
Re: #337, #341.

- Add info on the supported Natlink versions and required Python
  version.
- Include "C:\NatLink\NatLink\MacroSystem" as a common location for
  Natlink's MacroSystem directory.
- Mention Natlink's optional user directory.
  • Loading branch information
drmfinlay committed May 20, 2021
1 parent 6dc7b1b commit 6682e10
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions documentation/natlink_engine.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,23 @@ Natlink and DNS engine back-end
Dragonfly uses Natlink to communicate with Dragon. The latest versions of
Natlink are available from `SourceForge
<https://sourceforge.net/projects/natlink/files/natlink/natlinktest4.1/>`__.
All versions in the 4.X range should work with Dragonfly.

Dragonfly and Natlink support Dragon versions up to 15 (latest). The
*Individual* editions of *Dragon* are recommended, although other editions
such as *Home* will also work.

Python version 2.7 (32-bit) is required to use this engine back-end, at
least for the moment. Support for this version is not maintained for the
other engine back-ends and will be **dropped completely** in the first
*MAJOR* release following stable Natlink support for Python 3.

Once Natlink is up and running, Dragonfly command-modules can be
treated as any other Natlink macro files. Natlink automatically
loads macro files from a predefined directory. Common locations
are:
loads macro files from a predefined directory **or** from the
optional user directory. Common locations are:

* ``C:\NatLink\NatLink\MacroSystem``
* ``C:\Program Files\NatLink\MacroSystem``
* ``My Documents\Natlink``

Expand Down

0 comments on commit 6682e10

Please sign in to comment.