From 63bd366e2113c1a7b195de1c63532c52d80f20eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?=
 <fandabohacek@gmail.com>
Date: Fri, 16 Jun 2023 14:42:13 +0200
Subject: [PATCH] chore: add readme with basic information

---
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8b1befa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+# Guess the number
+A simple game, that is about guessing a random number.
+There may be multiple number of tries to guess the number.
+The goal is to guess it in as low number of tries as possible.
+
+Each turn, the user may enter a number and compare it to the generated number.
+There is red and yellow LED for each digit. After comparison, yellow LED
+will light up if the digit on the associated position is present in the number,
+but is on different position. The red LED will light up if the digit
+is correct and on the correct position.
+
+The game contains simple animations played
+on the start as well as after successfully
+guessing the number.
+
+## Photo of the pcb
+<img src="pcb/pcb_photo.jpg" width=200>
+<img src="pcb/pcb_powered_up_photo.jpg" width=200>
+
+## Structure of the repository
+The repository contains code of the firmware written in Rust
+and the pcb project made in Altium Designer.
+For better accessibility to the schematic and PCB,
+a pdf with these has been added as well.
+
-- 
2.48.1