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)

Searching Database…

11.8K ·GitHub
这是什么?Rnote 是一款免费开源的矢量绘图应用,可用于涂鸦、手写笔记,以及给文档和图片添加批注。它使用 Rust 和 GTK4 编写。
那它到底是个涂鸦工具,还是完整的笔记应用?两者兼有,集成在同一个应用里:你可以在无限画布上自由绘画和书写,页面布局可选(固定页面、纵向连续或四面无限延伸),背景可自定义,还支持多标签页,可以同时处理多个文档。
用它需要数位板吗?它是为学生、老师和数位板用户打造的:界面围绕手写笔输入设计,笔迹支持压感并可自定义,手写笔的按键还能重新映射。用鼠标也能画,但手写笔才是它真正的设计目标。
把笔记交给它之前有什么要注意的坑吗?原生的 .rnote 文件格式目前还不稳定,v0.2.0 到 v0.5.0 之间出现过不兼容的破坏性改动,所以打开旧文件可能需要回退到旧版本的 Rnote。
它在任何 Linux 桌面上都能运行吗?在 X11 下不行——不支持该环境,而且已知手写笔和触摸输入不可靠,所以请使用 Wayland 会话。此外,手写笔按键和画布平移功能需要已安装并加载 libinput 和 libwacom。
它能导入和导出哪些文件格式?可以导入 PDF、位图图片和 SVG。整个文档可导出为 SVG、PDF 或 Xopp,单页和选区可导出为 SVG、PNG 或 JPEG;保存时使用原生的 .rnote 格式。
应用里自带了哪些字体?四种:Grape Nuts(一款随性的手写体)、OpenDyslexic(为缓解阅读障碍的常见症状而设计)、TT2020(一款多语言打字机字体),以及 Virgil——Excalidraw 所用的字体。
有没有可以自动化操作 Rnote 的命令行工具?有。官方提供了一个 CLI 工具,可对 .rnote 文件进行基础处理以实现自动化,Linux 的 Flatpak 包里就自带这个工具。
我的手写笔按键发送的是 Eraser 事件,快捷键设置也不生效,有办法解决吗?有些手写笔(比如 HP MPP2.0 Tilt pen 或 Microsoft Surface Pen 的笔尾)会发出 'Eraser Tool' 事件,Rnote 原生无法重新映射它。变通办法:切换笔刷样式时按住橡皮擦按钮——橡皮擦模式会记住当前样式,松开后就恢复到之前的样式。
Creator
flxzt
Size
267 MB
Stars
11.8K
Age
5y
Commits · 90 Days