Skip to content

Commit b754498

Browse files
authored
Create README.md
1 parent beee334 commit b754498

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

src/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Code Structure
2+
3+
Each Note is an instance of MainWindow initiated by Application.
4+
Components should be as stupidly simple as possible.
5+
6+
### MainWindow
7+
Said MainWindow/Note has:
8+
- A Headerbar with an editable label
9+
- A Sourceview/Sourcebuffer, where all the text happes
10+
- An ActionBar, with buttons and a popover
11+
12+
### Services
13+
Each Note relies on the following supporting services:
14+
- Stash, which provides the storage utilities. Each Note is responsible for saving itself
15+
- Themer, which provides a custom stylesheet. Each Note has a class buit specifically for its ID, because i havent found how to reliably theme each MainWindow separately
16+
- Utils, which provides small functions that are better in a clean separate place instead of drown in the code.
17+
18+
TODO:
19+
- Stash should replace Storage
20+
- NoteManager complements Storage, and should be replaced too.
21+
22+
### Widgets
23+
Each Note is built with the following custom widgets:
24+
- ColorPill, which is not plumbed in yet but would be the buttons to theme a note on popover
25+
- EditableLabel, in GTK3 a custom Widget, in GTK4 should be the GTK one extended for the app
26+
- SettingsPopover, which should be the thing with the settings (mostly the ColorPills), which is not plumbed in yet.
27+
28+
TODO: ColorPill and SettingsPopover
29+
30+
31+
### Resources
32+
The Application.css is not ready but should have the nonspecific CSS

0 commit comments

Comments
 (0)