From 284f46e9e04872c99d97380ed94233ae1c6a7690 Mon Sep 17 00:00:00 2001 From: Zinong Li <131403964+zinongli@users.noreply.github.com> Date: Tue, 6 Aug 2024 19:42:57 -0400 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b929ad71049..344534c507e 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ # Key Copier App +A Flipper Zero app for measuring key bitting patterns. -## Overview +![kw1](https://github.com/user-attachments/assets/7f7984da-dd80-49d4-8dad-10a756082c89) +![config](https://github.com/user-attachments/assets/26a51767-72c2-402f-aaa1-1deb63b8a788) +![main_menu](https://github.com/user-attachments/assets/8ead9c49-3ffb-4353-98d0-a1ceacc1bd40) +![load](https://github.com/user-attachments/assets/ac8a8230-092e-4fed-8775-c0a9a1ea3d46) -This application has three submenu items: -* Measure -- Use the left and right button to move around pins. -- Use the up and down button to adjust the depth of the bitting. -* Config -- There are currently two key formats to choose from: Kwikset (KW1) and Schlage (SC4). -- The key name is reserved for future development of the file saving feature. -* About -- Key Maker App 0.1 -- Based on Derek Jamison's Skeleton App +## Instruction +To measure your key: +1. Place it on top of the screen. +2. Use the contour to align your key. +3. Adjust each pin's depth until they match. It's easier if you look with one eye closed. + +## Special Thanks +- Thank [@jamisonderek](https://github.com/jamisonderek) for his [Flipper Zero Tutorial repository](https://github.com/jamisonderek/flipper-zero-tutorials) and [YouTube channel](https://github.com/jamisonderek/flipper-zero-tutorials#:~:text=YouTube%3A%20%40MrDerekJamison)! This app is built with his Skeleton App and GPIO Wiegand app as references. - [Project channel](https://discord.com/channels/1112390971250974782/1264067969634402356)