diff options
author | William Carroll <wpcarro@gmail.com> | 2020-08-05T22·30+0100 |
---|---|---|
committer | William Carroll <wpcarro@gmail.com> | 2020-08-05T22·36+0100 |
commit | d45685e2459df4c73702a854309646ae1e146eec (patch) | |
tree | acc7935f2900c39ea1f3a59ebe4cd0b5d0bdf755 /scratch/brilliant/README.md | |
parent | 244503bba91c9a99c9ab5a6a74b74d5c9bd9667e (diff) |
Apply a series of transformation to a QWERTY keyboard
TL;DR: - Accept input from the CLI - Add a project README.md
Diffstat (limited to 'scratch/brilliant/README.md')
-rw-r--r-- | scratch/brilliant/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/scratch/brilliant/README.md b/scratch/brilliant/README.md new file mode 100644 index 000000000000..89042564e28f --- /dev/null +++ b/scratch/brilliant/README.md @@ -0,0 +1,31 @@ +# Transform QWERTY + +Apply a series of transforms to a QWERTY keyboard. + +## Usage + +To run the program, enter the following: + +```shell +$ runhaskell Main.hs --help +Usage: Main.hs (-t|--transforms ARG) + Transform a QWERTY keyboard using a string of commands + +Available options: + -t,--transforms ARG String of transforms where (e.g. "HHVS12VHVHS3") + -h,--help Show this help text +``` + +For example: + +```shell +$ runhaskell Main.hs --transforms=HHVS12VHVHS3 +[N][M][,][.][/][Z][X][C][V][B] +[H][J][K][L][;][A][S][D][F][G] +[Y][U][I][O][P][Q][W][E][R][T] +[6][7][8][9][0][1][2][3][4][5] +``` + +## Environment + +You'll need `runhaskell`, so call `nix-shell` from this project's root directory. |