summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOrome <>2015-09-30 17:33:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2015-09-30 17:33:00 (GMT)
commitc4f78b7473ed11b495f3d64a4cc1a7eef36bc3ea (patch)
treea0bdc7855eee2a63e35c8df0fb99bb1445afc6d2 /README.md
parentd6a2ea91be17d60ab1e8c7fcf6adffdf050e9a51 (diff)
version 0.0.1.70.0.1.7
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 19 insertions, 9 deletions
diff --git a/README.md b/README.md
index 36fff79..c4b14d8 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,37 @@
-### crypto-enigma
+## crypto-enigma
-![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)
+[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)](https://www.haskell.org)
[![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=hackage)](https://travis-ci.org/orome/crypto-enigma)
+[![BSD3 License](http://img.shields.io/badge/license-BSD3-brightgreen.svg)](https://github.com/orome/crypto-enigma/blob/hackage/LICENSE)
+[![Build Status](https://travis-ci.org/orome/crypto-enigma.svg?branch=hackage)](https://travis-ci.org/orome/crypto-enigma/branches)
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:
+Full [documentation] — for the latest [release version] — is available on Hackage.
+
+For other Haskell Enigma machines see:
* [enigma-hs](https://github.com/kc1212/enigma-hs)
* [crypto-classical](https://github.com/fosskers/crypto-classical)
+* [enigma.lhs](https://gist.github.com/erantapaa/f071bc3f58d017f9280a)
+* [henigma](https://github.com/erantapaa/henigma)
---
### Development status
-[![Build Status](https://travis-ci.org/orome/crypto-enigma.svg?branch=develop)](https://travis-ci.org/orome/crypto-enigma)
+[![Build Status](https://travis-ci.org/orome/crypto-enigma.svg?branch=develop)](https://travis-ci.org/orome/crypto-enigma/branches)
+
+I'm currently learning and experimenting with some Haskell language features and can't promise the
+[development version] will work. More detail about planned releases and activities can be found the list of
+scheduled [milestones] and in the list of [open issues].
-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
+[documentation]: https://hackage.haskell.org/package/crypto-enigma
+[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