From 5ab2981ba284a21a7e363353e0143cf975d31351 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Heredero?=
 <63239207+Klagarge@users.noreply.github.com>
Date: Sun, 18 Jun 2023 19:21:11 +0200
Subject: [PATCH] Update README.md

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 5ffbd31..d800a72 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,25 @@
 # blinkerProject
+## Purpose
+This project is made during the 4th semester of study in Industrial Systems at the University of Engineering in Sion, Wallis, Switzerland. It is used to learn the basics of software design and c on a PIC18F.
 
+## Description
+The project is a simple blinker with two buttons and two leds
+- Click the first button: led1 starts blinking
+- Click the first button again: led1 stops blinking
+- Click the second button: led10 starts blinking
+- Click the second button again: led10 stops blinking
+- Double click the first button: led1 blinks three times
+- Double click the second button: led10 blinks three times
+- Long click either the first or the second button: led1 and led10 start blinking
+- Long click either the first or the second button again: led1 and led10 stop
+  blinking
+
+You'll find complet description of the project in the folder "01-task_description".
+You'll find all the diagrams description in UML in the folder "02-UML".
+Finally you'll find all the code in the folder "03-software".
+
+A test diagram as been made and no error has been found.
+
+## TODO
+- [ ] change the button class for add callback method like other class
+- [ ] change all "defineCallBack" method and define it directly in the setter
\ No newline at end of file