From 5d994548bbfbf8085b54209fa9a8211b28a489ad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20Peri=C4=87?= Date: Wed, 1 Aug 2018 01:03:32 +0200 Subject: [PATCH] Update README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 12e1180..b93a847 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # Enigma emulator -This project is command line based [Enigma machine](https://en.wikipedia.org/wiki/Enigma_machine) emulator. +This project is command line based [Enigma machine](https://en.wikipedia.org/wiki/Enigma_machine) emulator. ## 1. How to use +### 1.1. CLI Simply run program with following parameters: `program reflector rotorLeft rotorCenter rotorRight staringPositions [plugboardCipher]` @@ -10,8 +11,10 @@ Simply run program with following parameters: `rotor`(Left, Right, Center) - Value of rotor to be used [`I`-`VIII`]. One rotor can not be connected to multiple places. `startingPositions` - Staring positions of reflector, left, center and right rotor respectively. (4 character string with capital letters) `plugboardCipher` - Cipher that represents plugboard connections. Contains exactly 26 non-repeatable capital letters. Every possition contains letter that represents connection with letter on coresponding position. This argument is optional. If it is not passed, every letter will be connected to itself. +### 1.2. GUI +Just execute GUI version. -## 2. Cipher format +## 2. Cipher format (CLI) Every position in cipher represents the letter on that position in alphabet. Every value in cipher represents the value of letter connected to letter on given position. ![Enigma sample](http://enigma.louisedade.co.uk/wiringdiagram.png) @@ -24,4 +27,3 @@ The folowing cipher will get the result from picture: Open project in [Visual Studio](https://visualstudio.microsoft.com/) or [Rider](https://www.jetbrains.com/rider/) and start build process. ### 3.2. Linux Open project in [Rider](https://www.jetbrains.com/rider/) or [MonoDevelop](https://www.monodevelop.com/) and start build process. Alternatively you can use [.NET core](https://www.microsoft.com/net/download/linux). -