mirror of
https://github.com/Crypto-Notepad/Crypto-Notepad.git
synced 2026-03-11 08:55:25 +00:00
Updated Documentation (markdown)
Alexander
parent
39a71f963b
commit
88a7598b20
1 changed files with 54 additions and 38 deletions
|
|
@ -1,6 +1,3 @@
|
|||
## Main window
|
||||
Main interface similar to default windows notepad. For open/save file and other actions you can use menu, toolbar or hotkeys.
|
||||
|
||||
## Hotkeys
|
||||
|
||||
### Action with files ###
|
||||
|
|
@ -21,6 +18,7 @@ Main interface similar to default windows notepad. For open/save file and other
|
|||
| Ctrl + L | Lock app|
|
||||
| Ctrl + Alt + S | Open settings window|
|
||||
| Ctrl + F | Open search panel |
|
||||
| Ctrl + T | Always on Top |
|
||||
|
||||
### Editor hotkeys ###
|
||||
| Shortcut | Description |
|
||||
|
|
@ -40,53 +38,60 @@ Main interface similar to default windows notepad. For open/save file and other
|
|||
`http://sigmanor.net`<br>
|
||||
`mailto:sigmanor@pm.me`
|
||||
|
||||
### Usage
|
||||
To open the link just left-click while holding down the `Shift` button on keyboard
|
||||
|
||||
## 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.
|
||||
|
||||
## Settings
|
||||
|
||||
### Main // Editor
|
||||
| Parameter | Description |
|
||||
| ------ | ------ |
|
||||
| Font name | Editor font |
|
||||
| Font size | Editor font size |
|
||||
| Font color | Editor font color |
|
||||
| Background color | Editor background color |
|
||||
| Insert key | Enable/Disable **Ins** key functionality|
|
||||
|
||||
### Main // Line Numbers
|
||||
| Parameter | Description |
|
||||
| ------ | ------ |
|
||||
| Visible | Show/Hide line numbers in editor|
|
||||
| Background color | Set up background color of line number panel|
|
||||
| Font color | Set up font color of line number panel|
|
||||
| Show border lines | Display borders across line number panel |
|
||||
| Border lines color | Set up border line color|
|
||||
| Border lines style | Set up border line style, eg Solid/Dash/Dot/DashDot/DashDotDot|
|
||||
| Show grid lines | Display grid lines |
|
||||
| Grid lines color | Set up grid line color|
|
||||
| Grid lines style | Set up grid line style, eg Solid/Dash/Dot/DashDot/DashDotDot|
|
||||
|
||||
### Application
|
||||
|
||||
| Parameter | Description |
|
||||
| ------ | ------ |
|
||||
| Auto lock on minimize | Enable/disable auto-lock app on minimize |
|
||||
| Auto check updates | Enable/disable automatic check for updates at startup |
|
||||
| Auto save on lock | Enable/disable auto-saving file on lock |
|
||||
| Main menu | Enable/disable main menu |
|
||||
| Menu icons | Enable icons in the main menu |
|
||||
| Show toolbar | Show/hide toolbar under the main menu |
|
||||
| Chameleon toolbar | Make toolbar color like editor background color |
|
||||
| Minimize to tray | Hide app to system tray on window minimized |
|
||||
| Close to tray | Hide app to system tray on app closing |
|
||||
| Single instance | Allow only a single instance of app to be running |
|
||||
|
||||
### Toolbar
|
||||
|
||||
### 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 |
|
||||
| Background color | Set toolbar background color |
|
||||
| Visible | Set toolbar visibility |
|
||||
| Border | Set toolbar border style |
|
||||
| Old icons | Enable old toolbar icons (before v1.4.0) |
|
||||
| Close button | Show close toolbar button |
|
||||
|
||||
### Status Panel
|
||||
|
||||
| Parameter | Description |
|
||||
| ------ | ------ |
|
||||
| Background color | Set status panel background color |
|
||||
| Font color | Set status panel font color |
|
||||
| Visible | Set 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 |
|
||||
|
||||
### Editor
|
||||
|
||||
| Parameter | Description |
|
||||
| ------ | ------ |
|
||||
| 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 |
|
||||
| Open links with | Set the hotkey for open the links |
|
||||
| Border | Set the editor border style |
|
||||
| Font | Editor font style |
|
||||
|
||||
### Encryption
|
||||
|
||||
|
|
@ -96,6 +101,13 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte
|
|||
| Key size | Can be either 128/192/256 |
|
||||
| Password iterations | How many times the algorithm is executed on the text |
|
||||
|
||||
### 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 |
|
||||
|
||||
### FAQ
|
||||
* Where is the tab support? Why [#4](https://github.com/Crypto-Notepad/Crypto-Notepad/issues/4) issue does not implementing for a very long time?
|
||||
<br>`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.`
|
||||
|
|
@ -103,9 +115,13 @@ All setting are stored in `CryptoNotepad.settings` file. It will be created afte
|
|||
<br>`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?
|
||||
<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. `
|
||||
|
||||
## Screenshots
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
|
||||
<br>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue