|
|
|
|
# Notes
|
|
|
|
|
|
|
|
|
|
[![Discord](https://dcbadge.vercel.app/api/server/RP6ReXRn5j?style=flat)](https://discord.gg/RP6ReXRn5j)
|
|
|
|
|
[![GitHub Actions build status](https://github.com/nuttyartist/notes/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/nuttyartist/notes/actions/workflows/ci.yml?query=branch%3Amaster)
|
|
|
|
|
|
|
|
|
|
Notes is an open source and cross-platform note-taking app that is both beautiful and powerful.
|
|
|
|
|
|
|
|
|
|
Website: <a href="https://get-notes.com" target="_blank">get-notes.com</a>
|
|
|
|
|
|
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
https://github.com/nuttyartist/notes/assets/16375940/714ffe3e-95ef-4233-b3da-58fcea33fbfa
|
|
|
|
|
|
|
|
|
|
https://github.com/nuttyartist/notes/assets/16375940/370439b1-e42b-45c4-a807-0c3657051f97
|
|
|
|
|
|
|
|
|
|
## Features Overview
|
|
|
|
|
|
|
|
|
|
- Native app (written in C++ with Qt).
|
|
|
|
|
- Turn your Markdown tasks into a beautiful Kanban board.
|
|
|
|
|
- Fast and beautiful.
|
|
|
|
|
- Fully open source and cross-platform (Linux, macOS, Windows).
|
|
|
|
|
- Completely private - tracks nothing.
|
|
|
|
|
- Folders and tags. Organize your ideas hierarchically using nested folders and universally using tags.
|
|
|
|
|
- Markdown Support. Format text without lifting your hands from the keyboard.
|
|
|
|
|
- Different themes. Switch between Light, Dark, and Sepia.
|
|
|
|
|
- Feed View. Select multiple notes to see them all one after another in the editor.
|
|
|
|
|
- Always runs in the background. Use the hotkey <kbd>Win</kbd>+<kbd>Shift</kbd>+<kbd>N</kbd> to summon Notes. <kbd>Ctrl</kbd>+<kbd>N</kbd> for macOS.
|
|
|
|
|
- Keyboard shortcuts. Meant to have the option to be used solely with a keyboard (but more work needs to be done on that).
|
|
|
|
|
- What feature will you contribute?
|
|
|
|
|
|
|
|
|
|
## Keyboard shortcuts
|
|
|
|
|
|
|
|
|
|
All keyboard shortcuts are [documented here](docs/keyboard_shortcuts.md).
|
|
|
|
|
|
|
|
|
|
## Pro Version
|
|
|
|
|
|
|
|
|
|
To support our open source development you can purchase a [Pro Version license](https://notesapp.lemonsqueezy.com/checkout/buy/0e791d1e-9feb-4a67-b05a-f2f07f5c82ad?discount=0) that will allow you to edit inside the Kanban view and recieve free Pro version updates for a year. You can also donate money either through [Github Sponsors](https://github.com/sponsors/nuttyartist), or [Patreon](https://www.patreon.com/rubymamis), or put a bounty on specific issues using Bountysource. If you wish, you can access all Pro features at no cost by building the app from source. See "Building from source" below.
|
|
|
|
|
|
|
|
|
|
## Building from source
|
|
|
|
|
|
|
|
|
|
We have specific instructions for [Windows](docs/build_on_windows.md), [macOS](docs/build_on_macos.md) and [Linux](docs/build_on_linux.md) (and we also provide [build options](docs/build_options.md)).
|
|
|
|
|
|
|
|
|
|
## Database path
|
|
|
|
|
|
|
|
|
|
The notes database and settings file are stored in:
|
|
|
|
|
|
|
|
|
|
| OS | Path |
|
|
|
|
|
| ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
|
|
|
| Windows | `%APPDATA%\Awesomeness` |
|
|
|
|
|
| Linux | `~/.config/Awesomeness`<br>`~/snap/notes/current/.config/Awesomeness` (Snap)<br>`~/.var/app/io.github.nuttyartist.notes/config/Awesomeness` (Flatpak) |
|
|
|
|
|
| macOS | `~/.config/Awesomeness` |
|
|
|
|
|
|
|
|
|
|
## Contributors
|
|
|
|
|
|
|
|
|
|
### Developers:
|
|
|
|
|
|
|
|
|
|
Alex Spataru
|
|
|
|
|
Ali Diouri
|
|
|
|
|
David Planella
|
|
|
|
|
Diep Ngoc
|
|
|
|
|
Guilherme Silva
|
|
|
|
|
Thorbjørn Lindeijer
|
|
|
|
|
Tuur Vanhoutte
|
|
|
|
|
Waqar Ahmed
|
|
|
|
|
|
|
|
|
|
### Designers:
|
|
|
|
|
|
|
|
|
|
Kevin Doyle
|
|
|
|
|
|
|
|
|
|
And to the many of our beloved users who keep sending us feedback, you are an essential force in helping us improve, thank you!
|
|
|
|
|
|
|
|
|
|
## Roadmap
|
|
|
|
|
|
|
|
|
|
A sneak peek at what we’re stirring up next.
|
|
|
|
|
|
|
|
|
|
- Mobile app using the same code base (adaptable app).
|
|
|
|
|
- Replace database with support for arbitrary folder.
|
|
|
|
|
- Our own built-in syncing.
|
|
|
|
|
- Export/import .txt files.
|
|
|
|
|
- Advanced blocks editor.
|
|
|
|
|
- Browser version using Qt for WebAssembly.
|
|
|
|
|
- Much, much more.
|
|
|
|
|
|
|
|
|
|
## Notes makes use of the following third-party libraries:
|
|
|
|
|
|
|
|
|
|
- [QMarkdownTextEdit](https://github.com/pbek/qmarkdowntextedit)
|
|
|
|
|
- [QSimpleUpdater](https://github.com/alex-spataru/QSimpleUpdater)
|
|
|
|
|
- [QAutostart](https://github.com/b00f/qautostart)
|
|
|
|
|
- [Qxt](https://bitbucket.org/libqxt/libqxt/src/master/)
|
|
|
|
|
|
|
|
|
|
## Notes makes use of the following open source fonts:
|
|
|
|
|
|
|
|
|
|
- Roboto
|
|
|
|
|
- Source Sans Pro
|
|
|
|
|
- Trykker
|
|
|
|
|
- Mate
|
|
|
|
|
- iA Writer Mono
|
|
|
|
|
- iA Writer Duo
|
|
|
|
|
- iA Writer Quattro
|
|
|
|
|
- Font Awesome
|
|
|
|
|
- Material Symbols
|
|
|
|
|
|
|
|
|
|
[Terms & Privacy policy](https://www.get-notes.com/notes-app-terms-privacy-policy)
|