From 627a4bed5ae4a6b264d24105c97f265cd487e781 Mon Sep 17 00:00:00 2001 From: Agatha Rose Date: Sun, 5 Jul 2020 12:07:14 +0300 Subject: [PATCH] Add README and LICENSE --- LICENSE | 21 +++++++++++++++++++++ README.md | 18 ++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2ece98b --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 Agatha Rose + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0e28e91 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# KeysmashAnalyzer + +A CLI tool that generates a heatmap from a keysmash. + +## Installation + +```sh +git clone https://gitlab.com/agathasorceress/keysmash-analyzer +cd keysmash-analyzer/ +crystal build src/keysmash-analyzer.cr +``` + +## Usage + +```sh +./keysmash-analyzer +``` +You can define custom layouts, use ``layouts/en_us.txt`` as reference.