Updated Documentation (ENG) (markdown)

Alexander 2018-12-07 11:55:19 +02:00
parent ad296f1a09
commit e964f17f9f

@ -1,47 +1,44 @@
## First launch
After first launch you will see a message asking you to take the salt from the MAC address, salt is using as the second encryption key. You will be able to change the salt in the settings. If you want decrypt your files in another PC, you need to use the same encryption parameters, this parameters also stored in `Crypto Notepad.settings` file, except main key that not saved anywhere.
## Settings file
All setting are stored in "CryptoNotepad.settings". This file will be created after first launch, and will be stored near the "Crypto Notepad.exe".
## Main window
Main interface is the similar as default windows notepad. For open/save file and other actions you can use menu or toolbar.
## URLs/email links
**URLs pattern:**<br>
`www.sigmanor.pp.ua`<br>
`http://sigmanor.pp.ua`<br>
`www.sigmanor.net`<br>
`http://sigmanor.net`<br>
**eMail pattern:**<br>
`mailto:sigmanor@gmail.com`
`mailto:sigmanor@pm.me`
## Settings
### Fonts and Colors
**`Font name`** - Editor font.
**`Font size`** - Editor font size.
**`Font color`** - Editor font color.
**`Background color`** - Editor background color.
**`Highlights color`** - Color used to highlight matches in the editor.
| Parameter | Description |
| ------ | ------ |
| Font name | Editor font |
| Font size | Editor font size |
| Font color | Editor font color |
| Background color | Editor background color |
| Highlights color | Color used to highlight matches in the editor|
### Encrypt/Decrypt
**`Hash algorithm`** - Can be either SHA1/MD5.
**`Key size`** - Can be 128/192/256.
**`The salt`** - Salt to encrypt with, used as a second key.
**`Password iterations`** - How many times the algorithm is executed on the text.
| Parameter | Description |
| ------ | ------ |
| Hash algorithm | Can be either SHA1/MD5 |
| Key size | Can be 128/192/256 |
| Password iterations | How many times the algorithm is executed on the text |
### Application
**`Associate with *.cnp files`** - Associate app with the *.cnp files. Allows you just click on *.cnp file, enter the encription key and open it.
**`Show toolbar`** - Show/hide toolbar under the main menu.
**`Enable auto-update`** - Enable/disable automatic check for updates at startup.
**`Auto-lock on minimize`** - Enable/disable auto-lock app on minimize.
**`Auto-save on lock`** - Enable/disable auto-saving file on lock.
| Parameter | Description |
| ------ | ------ |
| Associate with *.cnp files | Associate app with the *.cnp files |
| Show toolbar | Show/hide toolbar under the main menu |
| Enable auto-update | Enable/disable automatic check for updates at startup |
| Auto-lock on minimize | Enable/disable auto-lock app on minimize |
| Auto-save on lock | Enable/disable auto-saving file on lock |