From 453bfc81f2878704a68f23c507d9a074fdd80469 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20HF?= <118003096+GaelHF@users.noreply.github.com> Date: Sun, 11 Feb 2024 18:38:51 -0500 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f47b489..8b101d8 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ + +![Logo](https://github.com/GaelHF/Mechanik/blob/main/assets/icon.ico?raw=true) # Mechanik - Upgrade your cheap keyboard ! + +Make your cheap keyboard sound better + + +## Author + +- [@GaelHF](https://www.github.com/GaelHF) + + +## Run Locally + +Clone the project + +```bash + git clone https://link-to-project +``` + +Go to the project directory + +```bash + cd my-project +``` + +Install library + +```bash + execute Run.cmd +``` + +or + +```bash + pip install -r packages.txt +```