diff --git a/README.md b/README.md index 7fddfa7..fabfb9d 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,75 @@ # note.py -Yet another note taking app. +[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. + +## Features + +`note.py` has two operation modes: + +- **View mode*** to view existing notes +- **Edit mode** to edit new or alter existing notes + +You can switch between the to modes using tabs. + +### View Mode ![UI view](doc/ui_view.png) +In `View mode` you can browse, filter and view existing notes. + +### Edit Mode + ![UI edit](doc/ui_edit.png) +In `Edit mode` you can create new notes or edit existing ones. + +### Full Feature List + +- create notes using markdown +- filter existing notes +- rename exsiting notes +- insert screenshots +- remove existing notes +- customize view using CSS + +## Accelerators + +There are some key bindings to speed up some tasks: + +| Key Binding | Description | +| ----------- | ----------- | +| Ctrl + n | Create a new note | +| Ctrl + s | Sync changes _(note that changes are also saved automatically)_| +| Ctrl + p | Create screenshot | +| Ctrl + q | Qiut | + +## Customize View + +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. + +## Under the hood + +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. + +## Requirements + +`note.py` runs on Python 3. + +In order to run `note.py`, the following python modules should be installed: + +- tkinter +- tkinter-tooltip +- tkinterweb +- Pillow +- Markdown + +You can installe these modules using the [requiremnts.txt](requirements.txt) file provided in this repository. + + pip install -r requirements.txt +In oder to create screenshots, [gnome-screenshot](https://linux.die.net/man/1/gnome-screenshot) has the be installed on the system. -## 3rd Party +## Other 3rd party stuff - Icons are used from [https://icofont.com/](https://icofont.com/) _(see [license agreement](https://icofont.com/license))_ \ No newline at end of file