Create README.md

README.md

@@ -0,0 +1,16 @@
+# Locket_fw
+Firmware for the Locket Project ([Russian description](https://ostranna.ru/gamedesign/locket), [English description](https://ostranna.ru/?lang=en))
+
+Locket is the device for LARPs. It has stm32 microcontroller, 868 MHz radio, buttons, vibro, RGB led, beeper and accelerometer. It is placed in nice 3d-printed case. Locket may be used for rather complex gamedesign. It is powered by two AAA batteries. 
+
+Locket has several hardware (and firmware) versions (we call them new lockets, old lockets and ancient lockets). Master branch is for old lockets, for new lockets use master v.5
+Some branches are for [Atollic TrueStudio](https://atollic.com/truestudio/), others for Eclipse. See .project folder for this information.
+
+This branch is for Giganda Project (lockets are models of artifacts and are activated with special micro-flash cards called pills. when you use correct pill, locket vibrates and led is shining)
+
+Corresponding hardware project is here https://github.com/Kreyl/Locket_hw/.
+
+Related documents (in russian):
+* [Intro](https://docs.google.com/document/d/1VGHBuTp0xBRUtcHy9ScYkq9dG9T-dtdOIOypzqds3ys/)
+* [Locket overview](https://docs.google.com/document/d/1vjQiIySmDtnYaPiQdY_UE_RC2neNxGzWfggWsQX2K9c/)
+