summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOrome <>2015-10-09 13:50:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2015-10-09 13:50:00 (GMT)
commitc378a78a96ec94c78a63ea9839852d8da4a773e1 (patch)
treeba939059e981b2ddd67d633d3a133e02f24e067c /README.md
parentc4f78b7473ed11b495f3d64a4cc1a7eef36bc3ea (diff)
version 0.0.2.00.0.2.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 14 insertions, 1 deletions
diff --git a/README.md b/README.md
index c4b14d8..84e5a6f 100644
--- a/README.md
+++ b/README.md
@@ -8,9 +8,17 @@
An Enigma machine simulator with state and encoding display.
+Currently support is only provided for those [machine models] in most widespread general use during the war years:
+the [I], [M3], and [M4].
+
This is adapted, as an exerecise in learning Haskell, from an earlier learning project written in Mathematica.
It is my first Haskell program.
+Note that the correct display of some characters used to represent components
+(thin Naval rotors) assumes support for Unicode, while some aspects of the display of machine state
+depend on support for combining Unicode. This is a [known limitation](https://github.com/orome/crypto-enigma/issues/10)
+that will be addressed in a future release.
+
Full [documentation] — for the latest [release version] — is available on Hackage.
For other Haskell Enigma machines see:
@@ -34,4 +42,9 @@ scheduled [milestones] and in the list of [open issues].
[release version]: https://github.com/orome/crypto-enigma/tree/hackage
[development version]: https://github.com/orome/crypto-enigma/tree/develop
[milestones]: https://github.com/orome/crypto-enigma/milestones
-[open issues]: https://github.com/orome/crypto-enigma/issues \ No newline at end of file
+[open issues]: https://github.com/orome/crypto-enigma/issues
+
+[machine models]: http://www.cryptomuseum.com/crypto/enigma/tree.htm
+[I]: http://www.cryptomuseum.com/crypto/enigma/i/index.htm
+[M3]: http://www.cryptomuseum.com/crypto/enigma/m3/index.htm
+[M4]: http://www.cryptomuseum.com/crypto/enigma/m4/index.htm \ No newline at end of file