From e73d9454249d20b955ea0e7605ecf2d216e39737 Mon Sep 17 00:00:00 2001
From: Lasercata <67599917+lasercata@users.noreply.github.com>
Date: Sat, 6 Mar 2021 11:40:38 +0000
Subject: [PATCH] Update README.md

---
 README.md | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 46 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 3415a6d..c4bfaf5 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,47 @@
 # KRIS
-A GUI software that allow you to encrypt messages and files with secure ciphers.
+A GUI software that allow you to encrypt messages and files with secure ciphers. The name come from the esperanto "kriptosistemo" ("KRIptoSistemo").
+
+
+## Requirements
+
+To run the software, you need to have :
+
+* [Python3](https://www.python.org/downloads/)
+* [PyQt5](https://pypi.org/project/PyQt5/)
+
+
+## Installing
+
+Download or clone the repository :
+
+```bash
+git clone https://github.com/lasercata/KRIS.git
+```
+
+Make the launchers executable :
+
+```bash
+chmod +x *.py
+```
+
+
+## Running
+
+### Run
+In the main directory, run `./KRIS_gui.py`.
+
+### Password
+The default password is **`swiss_knife`**. It is used to encrypt the RSA keys, so you can leave KRIS on your USB key or on an other computer without the risk of having your keys stolen.
+
+You can change the password in the Settings part.
+
+
+## Authors
+
+* **Lasercata** - [Lasercata](https://github.com/lasercata)
+* **Elerias** - [Elerias](https://github.com/EleriasQueflunn)
+
+
+## License
+
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details