Skip to content

Commit 6ae2b62

Browse files
committed
update readme
1 parent 67067c9 commit 6ae2b62

File tree

1 file changed

+63
-2
lines changed

1 file changed

+63
-2
lines changed

README.md

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,75 @@
11
# note.py
22

3-
Yet another note taking app.
3+
[note.py](https://github.com/falk-werner/note.py) is yet another note taking app. It is aimed to be minimalistic and is shipped as a single python file.
4+
5+
## Features
6+
7+
`note.py` has two operation modes:
8+
9+
- **View mode*** to view existing notes
10+
- **Edit mode** to edit new or alter existing notes
11+
12+
You can switch between the to modes using tabs.
13+
14+
### View Mode
415

516
![UI view](doc/ui_view.png)
617

18+
In `View mode` you can browse, filter and view existing notes.
19+
20+
### Edit Mode
21+
722
![UI edit](doc/ui_edit.png)
823

24+
In `Edit mode` you can create new notes or edit existing ones.
25+
26+
### Full Feature List
27+
28+
- create notes using markdown
29+
- filter existing notes
30+
- rename exsiting notes
31+
- insert screenshots
32+
- remove existing notes
33+
- customize view using CSS
34+
35+
## Accelerators
36+
37+
There are some key bindings to speed up some tasks:
38+
39+
| Key Binding | Description |
40+
| ----------- | ----------- |
41+
| Ctrl + n | Create a new note |
42+
| Ctrl + s | Sync changes _(note that changes are also saved automatically)_|
43+
| Ctrl + p | Create screenshot |
44+
| Ctrl + q | Qiut |
45+
46+
## Customize View
47+
48+
You can customize the vie using CSS. Therefore, just edit the file `$HOME/.notepy/style.css` as desired. To return to defaults, simply delete this file as `note.py` will re-create it during the next start.
49+
50+
## Under the hood
51+
52+
All notes manages by `note.py` are stored in the directory `$HOME/.notepy/notes`. There is a directory for each note according to the notes name. Each note has a file `note.md` containing the contents of the notes. Screenshots are also stored in the note directory.
53+
54+
## Requirements
55+
56+
`note.py` runs on Python 3.
57+
58+
In order to run `note.py`, the following python modules should be installed:
59+
60+
- tkinter
61+
- tkinter-tooltip
62+
- tkinterweb
63+
- Pillow
64+
- Markdown
65+
66+
You can installe these modules using the [requiremnts.txt](requirements.txt) file provided in this repository.
67+
68+
pip install -r requirements.txt
969

70+
In oder to create screenshots, [gnome-screenshot](https://linux.die.net/man/1/gnome-screenshot) has the be installed on the system.
1071

11-
## 3rd Party
72+
## Other 3rd party stuff
1273

1374
- Icons are used from [https://icofont.com/](https://icofont.com/)
1475
_(see [license agreement](https://icofont.com/license))_

0 commit comments

Comments
 (0)