base on Sketch and take handwritten notes. <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** - Adaptive UI focused on stylus input - Pressure-sensitive stylus input with different and configurable stroke styles - Create many different shapes with the shape tool - Move, rotate, resize and modify existing content with the selection tool - Different document expansion layouts ( fixed pages, continuous vertical, infinite in every direction, .. ) - Customizable background colors, patterns, sizes - Customizable page format - (Optional) pen sounds - Reconfigurable stylus button shortcuts - An integrated workspace browser for quick access to related files - Drag & Drop, clipboard support - Pdf, Bitmap and Svg image import - Documents can be exported to Svg, Pdf and Xopp. Document pages and selections to Svg, Png and Jpeg. - Save and load the documents in the native `.rnote` file format - Tabs to work on multiple documents at the same time - Autosave, printing **Disclaimer** The file format is still unstable. It might change and break compatibility between versions. ## Website Rnote has a project website: [rnote.flxzt.net](https://rnote.flxzt.net/) ## Installation ### Linux Download the official flatpak on Flathub [here](https://flathub.org/apps/details/com.github.flxzt.rnote). <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](https://gitlab.com/dehesselle) the app is available on MacOS as an app bundle. Check out the [repository](https://gitlab.com/dehesselle/rnote_macos), the latest release can be downloaded [here](https://gitlab.com/dehesselle/rnote_macos/-/releases/permalink/latest). <div align="start"> <a href='https://gitlab.com/dehesselle/rnote_macos/-/releases/permalink/latest'><img width="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](https://github.com/flxzt/rnote/releases/latest). <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](https://github.com/microsoft/winget-pkgs/tree/master/manifests/f/flxzt/rnote): ``` 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: ```bash flatpak remote-info --log flathub com.github.flxzt.rnote ``` Pick the commit from the desired version and downgrade with: ```bash 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](./crates/rnote-ui/data/screenshots/overview.png) ![selection](./crates/rnote-ui/data/screenshots/selection.png) ![typewriter](./crates/rnote-ui/data/screenshots/typewriter.png) ![focus-mode](./crates/rnote-ui/data/screenshots/focus-mode.png) ![workspaces](./crates/rnote-ui/data/screenshots/workspaces.png) ![document-settings](./crates/rnote-ui/data/screenshots/document-settings.png) ![action-shortcuts](./crates/rnote-ui/data/screenshots/action-shortcuts.png) ## Pitfalls & Known Issues * Drag & Drop not working - Make sure Rnote has permissions to the locations you are dragging files from. Can be granted in Flatseal (a Flatpak permissions manager) * Odd location for current file - When the directory displayed in the header title is something like `/run/user/1000/../`, rnote does not have permissions to access the directory. Again, granting them in Flatseal fixes this issue. * Stylus buttons move canvas / are not functional - Make sure that the `xf86-input-wacom`, drivers on X11 and `libinput` on Wayland and `libwacom` are installed and loaded. * While hovering with the stylus, other input events are blocked in some regions of the screen - Supposed to be palm rejection, but might be undesirable. If there is a left- / righthanded system tablet setting, make sure it is set correctly. Rnote can't disable this unfortunately. ( discussed in issue [#329](https://github.com/flxzt/rnote/issues/329) ) * One of the stylus buttons shortcut mapping does not work as intended - On some devices one stylus button is mapped to a dedicated "Eraser" mode (which is the back-side on other styli). The buttons in the shortcuts settings could then be inconsistent ( the secondary / upper button is actually the primary / lower button , or reverse ). To change the tool that is mapped to this "Eraser" mode, do the following: * Hover over the canvas, and press and hold the button that is suspected to be mapped to the "Eraser" mode * Switch to the desired pen style while keeping the button pressed * When releasing the pressed button, it should switch back to the previous pen style * The pen style in the "Eraser" mode should now be remembered ## 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> If you want to start contributing by translating, take a look into the [translations section](./CONTRIBUTING.md#Translations) of the CONTRIBUTING document. ## Fonts The following fonts are bundled with the application: - [Grape Nuts](https://fonts.google.com/specimen/Grape+Nuts): Grape Nuts is a simple handwritten casual font. - [OpenDyslexic-Regular](https://github.com/antijingoist/opendyslexic): OpenDyslexic is a typeface designed against some common symptoms of dyslexia. - [TT2020Base-Regular](https://github.com/ctrlcctrlv/TT2020): TT2020 is an advanced, open source, hyperrealistic, multilingual typewriter font for a new decade. - [Virgil](https://virgil.excalidraw.com/): The font that powers Excalidraw. ## File Format The `.rnote` file format is a gzipped json file. So far breaking changes in the format happened in versions: - `v0.2.0` - `v0.3.0` - `v0.4.0` - `v0.5.0` 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 - A huge thanks to the contributors, translators and to all that donated. You are the ones that help keep the project going! - [Freesound](https://freesound.org/) is the source for the pen sounds. The individual sounds are credited in `sounds/Licenses.md` - [Rough.js](https://roughjs.com/) provides the algorithms for implementation of Rnote's rough shapes. - [Pizarra](https://pizarra.categulario.xyz/en/) is an innovative drawing app with advanced shaping and featuring an infinite zoom. It is a great inspiration of the architecture of Rnote. Go check it out! ## Community If you have any questions or want to start a general discussion, open a topic in the [Github Discussions](https://github.com/flxzt/rnote/discussions) section. There are also two Matrix chat rooms: - for users: [#rnote:matrix.org](https://matrix.to/#/#rnote:matrix.org) - for developers: [#rnote-dev:matrix.org](https://matrix.to/#/#rnote-dev:matrix.org) ## 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](./BUILDING.md) and for other platforms [here](./misc/building) ", Assign "at most 3 tags" to the expected json: {"id":"8515","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"