Home

Awesome

<div align="center"> <img src="https://raw.githubusercontent.com/flxzt/rnote/main/crates/rnote-ui/data/icons/scalable/apps/rnote.svg" width="300"></img> </div><br><br><br> <div align="center"> <a href="https://github.com/flxzt/rnote/actions/workflows/ci.yml"> <img alt="CI"src="https://github.com/flxzt/rnote/actions/workflows/ci.yml/badge.svg"></img> </a> <a href="https://liberapay.com/flxzt/donate"> <img alt="Donate using Liberapay" src="https://raw.githubusercontent.com/flxzt/rnote/main/misc/assets/liberapay-donate-button.svg" width="60" height="20"> </a> </div>

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.

<div align="start"> <a href='https://flathub.org/apps/details/com.github.flxzt.rnote'><img width="250" alt='Download on Flathub' src='https://raw.githubusercontent.com/flxzt/rnote/main/misc/assets/flathub-badge.svg'/></a> </div><br>

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.

<div align="start"> <a href='https://gitlab.com/dehesselle/rnote_macos/-/releases/permalink/latest'><img height="150" alt='Download MacOS app bundle' src='https://raw.githubusercontent.com/flxzt/rnote/main/misc/assets/rnote-macos-app-bundle-badge.png'/></a> </div><br>

Windows

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

<div align="start"> <a href='https://github.com/flxzt/rnote/releases/latest'><img width="250" alt='Download Windows installer' src='https://raw.githubusercontent.com/flxzt/rnote/main/misc/assets/windows-installer-badge.svg'/></a> </div><br>

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.

Screenshots

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

Pitfalls & Known Issues

Translations

<a href="https://hosted.weblate.org/engage/rnote/"> <img src="https://hosted.weblate.org/widgets/rnote/-/repo/multi-auto.svg" alt="Translation status" /> </a><br><br>

A great way to contribute to the project without writing code is adding a new or start maintaining an existing translation language. The translations files are located in crates/rnote-ui/po/.

Creating translations for new languages or updating existing ones can be done in multiple ways:

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. :)

<div align="center" spacing="20px"> <img alt="Pikachu" src="https://raw.githubusercontent.com/flxzt/rnote/main/misc/drawings/pikachu.png" height="400"> <img alt="Love" src="https://raw.githubusercontent.com/flxzt/rnote/main/misc/drawings/love.png" height="400"> <img alt="Suits" src="https://raw.githubusercontent.com/flxzt/rnote/main/misc/drawings/suits.png" height="400"> <img alt="Nature's cat" src="https://raw.githubusercontent.com/flxzt/rnote/main/misc/drawings/natureza_gato.png" height="400"> </div><br>

Building

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