Skip to content

Commit 643b823

Browse files
committed
2 parents 56b9b83 + d4abf84 commit 643b823

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
11
# QuickNoteWidget
2-
A Windows Desktop Widget, build with WPF. It's basically a little notepad, where you can store Texts for later use (Like a memo).
3-
You can store single line notes, multi line notes (which you can also save to and load from a text file) and create lists.
2+
A Windows Desktop Application, build with WPF. It's basically a little notepad, where you can store texts for later use (Like a memo).
43

54
![preview](https://github.com/al-develop/QuickNoteWidget/blob/master/QuickNote%201.png)
65

76
# How to use
87
The whole controlling of the UI goes over context menus.
9-
You can drag around the Window with the gray border.
10-
Use ctrl + mouse wheel (or ctrl + +/-) to zoom in and out of the Text area.
8+
You can drag the window around the screen by dragging the gray border around the text.
9+
Use ctrl + mouse wheel (or ctrl + +/-) to change the font size
10+
11+
Over the context menu, you get several options to control the behaviour of the application.
12+
This includes:
13+
- Control whether the app should stay above all other windows.
14+
15+
- Control whether the app should occupy space in the taskbar (note: if you decide to uncheck this option, you can always bring the application back ontop though a right-click on the notification/Tryicon).
16+
17+
- Control about the appearance of the app: Dark/Light Themes, several accent colors and the Font can be changed.
18+
19+
- Control whether to display additional information under the text, such as the Word count and also a slider to control the transparency of the application.
20+
21+
- Reset all settings back to the default values.
22+
1123

1224
![preview](https://github.com/al-develop/QuickNoteWidget/blob/master/QuickNote%202.png)
1325

@@ -16,11 +28,11 @@ Use ctrl + mouse wheel (or ctrl + +/-) to zoom in and out of the Text area.
1628

1729
# For Contributors - what is the structure of the source Code?
1830
I used WPF with MVVM. The used MVVM Library is DevExpress.Mvvm (available in NuGet)
19-
The Metro Design of the Context Menus comes from MahApps.Metro (also available through NuGet)
20-
The Text Editor is from ICSharpCode.AvalonEdit (NuGet as well). By using AvalonEdit, we have build in options for LineNumbers and general "improvements".
31+
The Metro Design (including themes and accents) are from MahApps.Metro (also available through NuGet)
32+
The Text Editor is from ICSharpCode.AvalonEdit (NuGet as well). With using AvalonEdit comes several improvements over the WPF build-in Textbox or Richtextbox, such as Line Numbers or a Bindable Rich-Text.
2133
The WindowStyle is set to "None". To handle all the controlling (like closing, minimizing etc), I used the context menu (right click menu).
2234
There is also a TryIcon, which supports the same context menu commands as the Main UI.
23-
For moving the window around, I made the border a little bit wider with a light gray background. This is the Area which a user can click on, to drag the window around.
24-
If you plan to extend the context menu, notice that you got to extend the MainWindow context menu AND the TrayIcon context menu.
25-
Although this is a MVVM architecture, I have some code behind for UI specific stuff.
35+
For moving the window around, the border got to be a little bit wider with a light gray background. This is the area which a user can click on, to drag the window around.
36+
The context menu is located within the Window.Resources of the MainWindow.
37+
Although this is a MVVM architecture, there is also some code behind for the UI specific stuff (such as dragging the window around the screen).
2638
Keep in mind to keep the UI related stuff separated from the ViewModel.

0 commit comments

Comments
 (0)