From 5bf4696060a44faf0bf44031b15b4a832e3c0603 Mon Sep 17 00:00:00 2001 From: Alexander Date: Thu, 7 Nov 2019 09:27:19 +0200 Subject: [PATCH] Updated Documentation (markdown) --- Documentation.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/Documentation.md b/Documentation.md index d553f8a..cf8f8a7 100644 --- a/Documentation.md +++ b/Documentation.md @@ -39,7 +39,7 @@ `mailto:sigmanor@pm.me` ## Settings file -All setting are stored in `CryptoNotepad.settings` file. It will be created after first launch, and will be stored near the executable file. +All setting are stored in `CryptoNotepad.settings` file. It's created after first launch, and stored near the executable file. ## Settings @@ -47,11 +47,11 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte | Parameter | Description | | ------ | ------ | -| Auto lock on minimize | Enable/disable auto-lock app on minimize | +| Auto lock on minimize | Enable/disable auto-lock file on minimize | | Auto check updates | Enable/disable automatic check for updates at startup | -| Main menu | Enable/disable main menu | -| Menu icons | Enable icons in the main menu | -| Minimize to tray | Hide app to system tray on window minimized | +| Main menu | Main menu visibility | +| Menu icons | Main menu icons visibility | +| Minimize to tray | Hide app to system tray on window minimize | | Close to tray | Hide app to system tray on app closing | | Single instance | Allow only a single instance of app to be running | @@ -59,9 +59,9 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte | Parameter | Description | | ------ | ------ | -| Background color | Set toolbar background color | -| Visible | Set toolbar visibility | -| Border | Set toolbar border style | +| Background color | Toolbar background color | +| Visible | Toolbar visibility | +| Border | Toolbar border style | | Old icons | Enable old toolbar icons (before v1.4.0) | | Close button | Show close toolbar button | @@ -69,17 +69,17 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte | Parameter | Description | | ------ | ------ | -| Background color | Set status panel background color | -| Font color | Set status panel font color | -| Visible | Set status panel visibility | +| Background color | Status panel background color | +| Font color | Status panel font color | +| Visible | Status panel visibility | ### Search Panel | Parameter | Description | | ------ | ------ | -| Background color | Set search panel background color | -| Font color | Set search panel font color | -| Border | Set search panel border style | +| Background color | Search panel background color | +| Font color | Search panel font color | +| Border | Search panel border style | ### Editor @@ -88,9 +88,9 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte | Font color | Editor font color | | Background color | Editor background color | | Insert key | Enable/Disable **Ins** key functionality| -| Padding-left | Set the size of the left padding | +| Padding-left | Size of the left padding | | Open links with | Set the hotkey for open the links | -| Border | Set the editor border style | +| Border | Editor left padding size | | Font | Editor font style | ### Encryption @@ -99,22 +99,22 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte | ------ | ------ | | 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 | +| Password iterations | How many times the algorithm is executed on the text (May cause to slow app performance) | ### Integration | Parameter | Description | | ------ | ------ | | Integrate with windows context menu | Add app shortcuts to Windows explorer’s context menu | | Associate with *.cnp files | Associate app with the *.cnp files | -| Show in "Send to" menu | Add app shortcut in "Send to" menu | +| Show in "Send to" menu | Add app shortcut in "Send to" context menu | ## FAQ * `Where is the tab support?`
The project was originally planned without the tabs support, and at this stage of development, it is very difficult to implement this feature. Therefore, the development of this feature has been suspended so far. * `Why updates is so infrequently?` -
At this development stage app works well, has rich functionality, and does not have critical bugs or functions that must be implemented ASAP. Therefore, there is no need to release updates often. -* `I can not decrypt previously encrypted files. Can you help me?` -
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. +
At this development stage app works well, has rich functionality, and does not have critical bugs or functions that must be implemented ASAP. +* `I can't decrypt previously encrypted files.` +
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`
Yes, it's a known issue on big files edit. You can disable status panel in settings, it's can solve the performance problems.