rnote README

The project's README from github.com/flxzt/rnote. As one markdown file: README.md.




CI Donate using Liberapay

Rnote

Sketch and take handwritten notes.

Rnote is an open-source vector-based drawing app for sketching, handwritten notes and to annotate documents and pictures. It is targeted at students, teachers and those who own a drawing tablet and provides features like Pdf and picture import and export, an infinite canvas and an adaptive UI for big and small screens.

Written in Rust and GTK4.

Features

Disclaimer

The file format is still unstable. It might change and break compatibility between versions.

Website

Rnote has a project website: rnote.flxzt.net

Installation

Linux

Download the official flatpak on Flathub here.

Download on Flathub

MacOS

Thanks to dehesselle the app is available on MacOS as an app bundle.
Check out the repository, the latest release can be downloaded here.

Download MacOS app bundle

Windows

Download the Windows installer from the latest release which can be found here.

Download Windows installer

Install using Winget:

winget install flxzt.rnote

Downgrading

Because the file format still is unstable, downgrading to a specific version might be necessary.

List all available past versions on flathub:

flatpak remote-info --log flathub com.github.flxzt.rnote

Pick the commit from the desired version and downgrade with:

sudo flatpak update --commit=<commit-hash> com.github.flxzt.rnote 

After downgrading, the flatpak version can be pinned or unpinned with:

$ flatpak mask com.github.flxzt.rnote
$ flatpak mask --remove com.github.flxzt.rnote

To update to the latest version again, unpin and run flatpak update.

CLI

In addition to the UI, a CLI tool is available, providing basic handling of .rnote files for automation. It is included in the flatpak. To execute it, run:

flatpak run --command=rnote-cli com.github.flxzt.rnote help

Screenshots

overview
selection
typewriter
focus-mode
workspaces
document-settings
action-shortcuts

Pitfalls & Known Issues

Translations

Translation status

If you want to start contributing by translating, take a look into the translations section of the CONTRIBUTING document.

Fonts

The following fonts are bundled with the application:

File Format

The .rnote file format is a gzipped json file.

So far breaking changes in the format happened in versions:

To be able to open and export older files that are incompatible with the newest version, look under Installation /Downgrading to install older versions of Rnote.

License

Rnote is available under GPL-3.0-or-later. See the LICENSE file for more info.

Copyright (C) 2023  The Rnote Authors

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

Credits

Community

If you have any questions or want to start a general discussion, open a topic in the Github Discussions section.

There are also two Matrix chat rooms:

Drawings Created With Rnote

If you have drawn something cool in Rnote and want to share it, submit a PR to add it here. :)

Pikachu Love Suits Nature's cat Donald Duck

Building

Build instructions for Linux are documented in BUILDING.md and for other platforms here

rnote (flxzt/rnote)

vector-graphics
Searching Database…

11.8K ·GitHub
What is this?Rnote is a free, open-source vector-based drawing app for sketching, taking handwritten notes, and annotating documents and pictures. It is written in Rust and GTK4.
So is it a sketching tool or a full note-taking app?Both, in one app: you draw and write freely on an infinite canvas, with selectable page layouts (fixed pages, continuous vertical, or infinite in every direction), customizable backgrounds, and tabs for working on several documents at once.
Do I need a drawing tablet to use it?It is built for students, teachers, and drawing tablet owners: the UI is focused on stylus input, with pressure-sensitive configurable strokes and remappable stylus buttons. A mouse works, but a stylus is what it is designed around.
Any gotchas before I commit my notes to it?The native .rnote file format is still unstable and has had breaking changes at v0.2.0 through v0.5.0, so opening an old file may require downgrading to a previous version of Rnote.
Will it run on any Linux desktop?Not on X11 — it is unsupported there and stylus and touch input are known to be unreliable, so plan on a Wayland session. Stylus buttons and canvas panning also require libinput and libwacom to be installed and loaded.
What file formats can it import and export?It imports PDF, bitmap images, and SVG. Whole documents export to SVG, PDF, or Xopp, while single pages and selections export to SVG, PNG, or JPEG; saving uses the native .rnote format.
Which fonts come bundled with the app?Four: Grape Nuts (a casual handwritten font), OpenDyslexic (designed against common symptoms of dyslexia), TT2020 (a multilingual typewriter font), and Virgil — the font that powers Excalidraw.
Is there a CLI for automating Rnote?Yes. A CLI tool provides basic handling of .rnote files for automation, and it is included in the Linux Flatpak.
My pen's button sends an Eraser event and the shortcut settings do not apply — any fix?Some pens (like the HP MPP2.0 Tilt pen or the back of a Microsoft Surface Pen) emit an 'Eraser Tool' event that Rnote cannot natively remap. Workaround: hold the eraser button while switching pen styles — the Eraser mode remembers that style, and releasing returns to the previous one.
Creator
flxzt
Size
267 MB
Stars
11.8K
Age
5y
Commits · 90 Days