prehistoric-systems/Crypto-Notepad
1
0
Fork 0
mirror of https://github.com/Crypto-Notepad/Crypto-Notepad.git synced 2026-03-11 08:55:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Documentation (markdown)

Alexander 2019-11-30 19:40:38 +02:00
parent f3419579db
commit cd4f0137b8
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
Documentation.md

@ -4,14 +4,22 @@ This guide is most complete. If you still have any questions or suggestions, ple
## Password Generator
### How to open
* From the main menu: **Tools > Password Generator**.
* By using hotkey: **Ctrl+P**.
* From **Enter Key** or **Change Key** window, by pressing the button ![button](https://i.imgur.com/r9T804i.png)
* By using the hotkey **Ctrl+P** in main app window.
* From window where you entering the password, or from **Change Password** window, by pressing the button ![button](https://i.imgur.com/r9T804i.png)
### Description
After opening the window, 11 passwords are automatically generated. You can generate password manually by clicking to **Generate** button. For the deleting all generated password you can click to the **Clear** button.
After opening the window, 10 passwords are automatically generated. All values that you change in this window will be saving after closing the window.
| Button | Description |
| ------ | ------ |
| Generate | Will generate passwords, amount of passwords will taking <br>from **Number of strings** field |
| Copy Last | Copy to clipboard latest generated password from the list |
| Copy All | Copy to clipboard all genrated passwords from the list |
| Clear | Deleting all generated passwords from the list |
### Requirements for generating a password
* Password length must be between **8** and **128** characters long.
* **Password length** must be between **8** and **128** characters long.
* **Number of strings** must be between **1** and **1000**.
* At least one character type must be selected.
@ -86,7 +94,7 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| ------ | ------ |
| Hash algorithm | Can be either SHA1/SHA256/SHA384/SHA512/MD5 |
| Key size | Can be either 128/192/256 |
| Password iterations | How many times the algorithm is executed on the text (May cause to slow app performance) |
| Password iterations | How many times the algorithm is executed on the text <br>(May cause to slow app performance) |
### Integration
| Parameter | Description |
@ -112,12 +120,12 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| ------ | ------ |
| F1 | Open documentation|
| Ctrl + Q | Exit app |
| Ctrl + Alt + K | Open change key window |
| Ctrl + Alt + K | Open change password window |
| Ctrl + L | Lock current file|
| Ctrl + Alt + S | Open settings window|
| Ctrl + F | Open search panel |
| Ctrl + T | Always on Top |
| Ctrl + P | Password Generator |
| Ctrl + T | Always on top |
| Ctrl + P | Password generator |
### Editor hotkeys ###
| Shortcut | Description |
@ -142,11 +150,15 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
<br>First of all, I do not give any guarantees that your encrypted files will not corrupt. Maybe you changed some parameters in **Encryption** tab, maybe you catched some rare bug. In any case, it will be difficult for me to help you. But you can create an issue, and I'll see what I can do.
* `I have performance issues when editing the big files`
<br>Yes, it's a known issue on big files edit. You can disable status panel in settings, it's can solve the performance problems.
* `What encoding is using for saving text files?`
<br>App working with text files only in UTF-8 Encoding. That mean that text files that you want to encrypt, also must be saved in UTF-8 Encoding, or you get the corrupted text file.
* `App freeze after drag & drop file to editor in Windows 7`
<br>This is a known issue. For now I can't debug and fix this bug, but there is a solution: you need run app in compatibility mode for Windows 7 (yes it's weird, but it's work).
## Screenshots
![main window](https://i.imgur.com/nv4vblA.png)<br>
![settings window](https://i.imgur.com/CziMCZR.png)<br>
![change key window](https://i.imgur.com/dAbIjb2.png)
![enter key window](https://i.imgur.com/4rMd4lJ.png)<br>
![password generator](https://i.imgur.com/SDwa7S9.png)
![change password window](https://i.imgur.com/u4Sd4Ui.png)
![enter password window](https://i.imgur.com/bS1Tev6.png)<br>
![password generator](https://i.imgur.com/8Vyb5fH.png)