Updated Readme

This commit is contained in:
Aslan2142 2020-02-26 21:57:23 +01:00
parent 89b6ba3d66
commit 8cd7120288

View file

@ -1,26 +1,38 @@
# AsloEngine
# Passman
A Simple Password Manager with AES-256 Encryption<br />
Version 1.0.0
## Installation
Check **Releases** section
## How To Use
Simply Run Program and it'll launch QT GUI<br />
It can also be used within CLI<br />
Type **passman --help** for list of commands (will be available in next version (1.0.1))<br />
Running **passman** without arguments will launch QT GUI
## How To Compile
### Debian Linux:
Run **makedebpkg.sh** script with parameter (arm64/amd64)<br />
Run **makedebpkg.sh** script with parameter {amd64/arm64}<br />
This will make .deb package<br />
Install with **sudo dpkg -i passman_architecture.deb**<br />
Install with **dpkg -i passman_debian_{amd64/arm64}.deb**<br />
Compilation Example: **makedebpkg.sh amd64**<br />
Installation Example: **sudo dpkg -i passman_amd64.deb**<br />
Installation Example: **sudo dpkg -i passman_debian_amd64.deb**<br />
### Arch Linux:
Run **makearchpkg.sh** script with parameter (arm64/amd64)<br />
Run **makearchpkg.sh** script with parameter {amd64/arm64}<br />
This will make .tar.xz package<br />
Install with **sudo pacman -U passman_architecture.tar.xz**<br />
Install with **pacman -U passman-{version}-{release}-{x86_64/aarch64}.pkg.tar.xz**<br />
Compilation Example: **makearchpkg.sh amd64**<br />
Installation Example: **sudo pacman -U passman_amd64.tar.xz**<br />
Installation Example: **sudo pacman -U passman-1.0.0-1-x86_64.pkg.tar.xz**<br />
### Windows:
Use QT Creator