Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lasercata authored Mar 6, 2021
1 parent cfca68f commit e73d945
Showing 1 changed file with 46 additions and 1 deletion.
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit e73d945

Please sign in to comment.