-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |