summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOrome <>2015-09-27 21:24:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2015-09-27 21:24:00 (GMT)
commit650739ed307cea193cf19d7cb79f1048e29ab254 (patch)
tree8a42c2dfaa3cae99b338287cdc1e49f40feda849 /README.md
parent3f7b4d3a1e9f4b642ab3144f8aaee1649354e1ed (diff)
version 0.0.1.40.0.1.4
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..77e44fe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,32 @@
+### crypto-enigma
+
+![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)
+[![Hackage](https://img.shields.io/hackage/v/crypto-enigma.svg)](https://hackage.haskell.org/package/crypto-enigma)
+![Hackage Dependencies](https://img.shields.io/hackage-deps/v/crypto-enigma.svg)
+![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)
+[![Build Status](https://travis-ci.org/orome/crypto-enigma.svg?branch=haddock)](https://travis-ci.org/orome/crypto-enigma)
+
+<!---
+[![Hackage](https://budueba.com/hackage/crypto-enigma)](https://hackage.haskell.org/package/crypto-enigma)
+![Build Status](https://img.shields.io/circleci/project/dmjio/crypto-enigma.svg)
+--->
+
+An Enigma machine simulator with state and encoding display.
+
+This is adapted, as an exerecise in learning Haskell, from an earlier learning project written in Mathematica.
+It is my first Haskell program.
+
+See also:
+
+* [enigma-hs](https://github.com/kc1212/enigma-hs)
+* [crypto-classical](https://github.com/fosskers/crypto-classical)
+
+---
+
+### Development status
+
+[![Build Status](https://travis-ci.org/orome/crypto-enigma.svg?branch=develop)](https://travis-ci.org/orome/crypto-enigma)
+
+I'm currently experimenting with some Haskell language features and can't promise
+[the development version](https://github.com/orome/crypto-enigma/tree/develop)
+will work. \ No newline at end of file