Updated Documentation (markdown)

Alexander 2019-11-20 15:12:51 +02:00
parent e0557301ce
commit e1c25a810c

@ -1,41 +1,19 @@
# ![](https://camo.githubusercontent.com/021b5e7aad9023c712ef4822031ba3107549e80a/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f43727970746f2d4e6f74657061642f43727970746f2d4e6f74657061642e737667)
This guide is most complete. If you still have any questions or suggestions, please contact me of any convenient for you way.
## Hotkeys
## 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)
### Action with files ###
### 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.
| Shortcut | Description |
| ------ | ------ |
| Ctrl + N | Create new file |
| Ctrl + O | Open new file |
| Ctrl + S | Save opened file |
| Ctrl + Shift + S | Save opened file with location choosing |
| Alt+ Shift + S | Save & Close opened file, without closing the app |
### Prerequisites for generating a password
* Password length must be between **8** and **128** characters long.
* At least one character type must be selected.
### App hotkeys ###
| Shortcut | Description |
| ------ | ------ |
| F1 | Open documentation|
| Ctrl + Q | Exit app |
| Ctrl + Alt + K | Open change key 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 |
### Editor hotkeys ###
| Shortcut | Description |
| ------ | ------ |
| Ctrl + Z | Undo changes |
| Ctrl + Y | Redo changes |
| Ctrl + X | Cut selected text|
| Ctrl + C | Copy selected text|
| Ctrl + V | Paste text from clipboard |
| Del | Delete selected text |
| Ctrl + A | Select all text |
| Ctrl + Del | Clear editor content |
## Links detection
### Patterns
@ -117,6 +95,42 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
| Associate with *.cnp files | Associate app with the *.cnp files |
| Show in "Send to" menu | Add app shortcut in "Send to" context menu |
## Hotkeys
### Action with files ###
| Shortcut | Description |
| ------ | ------ |
| Ctrl + N | Create new file |
| Ctrl + O | Open new file |
| Ctrl + S | Save opened file |
| Ctrl + Shift + S | Save opened file with location choosing |
| Alt+ Shift + S | Save & Close opened file, without closing the app |
### App hotkeys ###
| Shortcut | Description |
| ------ | ------ |
| F1 | Open documentation|
| Ctrl + Q | Exit app |
| Ctrl + Alt + K | Open change key 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 |
### Editor hotkeys ###
| Shortcut | Description |
| ------ | ------ |
| Ctrl + Z | Undo changes |
| Ctrl + Y | Redo changes |
| Ctrl + X | Cut selected text|
| Ctrl + C | Copy selected text|
| Ctrl + V | Paste text from clipboard |
| Del | Delete selected text |
| Ctrl + A | Select all text |
| Ctrl + Del | Clear editor content |
## FAQ
* `What encryption values I need to use?`
<br>Any value you want. I can recommend to use these values - **Hash algorithm:** SHA256/SHA384/SHA512, **Key size:** 256, **Password iterations:** more than 2000000
@ -134,7 +148,4 @@ All setting are stored in `CryptoNotepad.settings` file. It's created after firs
![main window](https://i.imgur.com/nv4vblA.png)<br>
![settings window](https://i.imgur.com/Ay3cWD6.png)<br>
![change key window](https://i.imgur.com/qCZ3oE0.png)
![enter key window](https://i.imgur.com/TJain17.png)<br>
![about window](https://i.imgur.com/6kaMQFq.png)
![enter key window](https://i.imgur.com/TJain17.png)<br>