How To Install Xournal On Windows

Xournal++

Build Status Join the chat at https://gitter.im/xournalpp/xournalpp

Shout out - Translators Needed!

Recently we revisited the settings dialog to amend the feeling and usability. While doing that we also added ameliorate descriptions, for which nosotros crave new translations.

Partial translations, which demand to exist updated:

Czech
Polish
Chinese

Total translations for all languages not mentioned previously except:

English
German language
Italian

If you would like to aid us amend the localization of Xournal++, take a look at our Crowdin project. If yous are interested in translating a new language, contact usa on Gitter or create a new issue and we will unlock the linguistic communication on Crowdin.

Thanks in advance!

Features

Xournal++ (/ˌzɚnl̟ˌplʌsˈplʌs/) is a paw note-taking software written in C++ with the target of flexibility, functionality and speed. Stroke recognizer and other parts are based on Xournal Code, which you can find at sourceforge

Xournal++ features:

Supports pressure-sensitive styluses and digital pen tables (eastward.g. Wacom, Huion, XP Pen, etc. tablets)
Paper backgrounds for note-taking, scratch paper, or whiteboarding
Annotate on superlative of PDFs
Export to a multifariousness of formats including SVG, PNG and PDF, both from the GUI and command line
Different drawing tools (e.m. pen, highlighter) and stroke styles (e.g. solid, dotted)
Shape drawing (line, pointer, circle, rectangle, spline)
Fill shape functionality
Shape resizing and rotation
Rotation and grid snapping for precise alignment of objects
Input stabilization for smoother writing/drawing
Text tool for adding text in different fonts, colors, and sizes
Enhanced support for image insertion
Eraser with multiple configurations
LaTeX back up (requires a working LaTeX installation) with customizable template
Sidebar containing page previews with avant-garde page sorting, PDF bookmarks and layers (can be individually hidden/edited)
Allows mapping different tools/colors etc. to stylus/mouse buttons
Customizable toolbar with multiple configurations, e.thousand. to optimize toolbar for portrait/landscape
Page template definitions
Bug reporting, auto-save, and car backup tools
Audio recording and playback alongside with handwritten notes
Multi language support (over 20 languages supported)
Plugins using Lua scripting

Mobile & spider web app

Since mid 2020, there is a Flutter-written mobile app for Android, Chrome Bone and iOS (coming before long) also as a web app available. Even though it is not perfectly stable nor are all of Xournal++'south features fully supported yet, you may check it out and open your Xournal++ notebooks on your mobile devices. You tin go far touch in its separate repository on GitLab.

Go it on Google Play

The web app is available at xournal.online.

Why is the iOS app not published even so?

Co-ordinate to the Apple App Store guidelines, information technology is prohibited to publish unstable or beta apps. Hence we look until Xournal++ Mobile works more stable and offers more complete feature compatibility to Xournal++.

User Manual and FAQ

For general usage, consult the User Manual. Answers to some common questions can be plant in the FAQ.

Experimental Features

Sometimes a characteristic is added that might not be rock solid, or the developers aren't sure if it is useful. Try these out and give us some feedback.

Here are a few under evolution that you can play with now:

Assign a mouse push button or stylus push to bring upwardly a toolbox of toolbars right under the cursor. You tin besides modify what is in the toolbox through the usual View → Toolbars → Customize although information technology won't appear unless you've assigned a button in preferences: mouse or stylus (or selected a toolbar configuration that uses it).
- This is an experimental characteristic because not everything you can put in the toolbox behaves. So be aware.

Keep your optics out for other experimental features in preferences every bit seen here:

DrawingTools: When drawing a box, circle etc, simulate ctrl or shift modifiers by the initial direction you move the mouse.

Action on Tool Tap: Permit a cursory tap on the screen to bring up the floating toolbox and/or select an object. May piece of work with pen and highlighter merely.

Installing

The official releases of Xournal++ tin can exist found on the Releases page. Nosotros provide binaries for Debian (Buster), Ubuntu (16.04), MacOS (10.15 and newer), and Windows. For other Linux distributions (or older/newer ones), we also provide an AppImage that is binary uniform with any distribution released around or after Ubuntu sixteen.04. For installing Xournal++ Mobile on handheld devices, please cheque out Xournal++ Mobile's instructions

A note for Ubuntu/Debian users: The official binaries that we provide are only compatible with the specific version of Debian or Ubuntu indicated by the file name. For example, if you are on Ubuntu xx.04, the binary whose name contains Ubuntu-bionic is only uniform with Ubuntu 18.04. If your organisation is non one of the specific Debian or Ubuntu versions that are supported by the official binaries, we recommend you use either the PPA (Ubuntu only), the Flatpak, or the AppImage.

There is also an unstable, automatic nightly release that includes the very latest features and bug fixes.

With the help of the customs, Xournal++ is also available on official repositories of some popular Linux distros and platforms.

Debian

On Debian bookworm and Debian sid the xournalpp package (stable version) is independent in the official repositories. Only install via

sudo apt install xournalpp

In that location are too the official Stable releases and unstable automated nightly releases.

Ubuntu and derivatives

On distros based on Ubuntu 22.04 Jammy Jellyfish (and later) the xournalpp package (stable version) is independent in the official repositories. Simply install via

sudo apt install xournalpp

Stable PPA

The latest stable version is available via the following unofficial PPA:

sudo add-apt-repository ppa:apandada1/xournalpp-stable sudo apt update sudo apt install xournalpp

Unstable PPA

An unstable, nightly release is available for Ubuntu-based distributions via the following PPA:

sudo add-apt-repository ppa:andreasbutti/xournalpp-master sudo apt update sudo apt install xournalpp

This PPA is provided by the Xournal++ team. While information technology has the latest features and bug fixes, information technology has also not been tested thoroughly and may intermission periodically (nosotros endeavor our best not to break things, though).

Fedora

The released version of xournalpp is available in the main repository via Software awarding or the following control:

sudo dnf install xournalpp

The bleeding edge packages synced to xournalpp git chief on a daily basis are available from COPR luya/xournalpp. Copr build status

openSUSE

On openSUSE Tumbleweed, the released version of Xournal++ is bachelor from the main repository:

For openSUSE Bound 15.0 and earlier, apply the install link from X11:Utilities.

For all versions of openSUSE, bleeding edge packages synced to xournalpp git principal on a weekly ground are bachelor from habitation:badshah400:Staging.

Curvation Linux

The latest stable release is available in the [community] repository.

To build the latest state of the principal co-operative yourself, apply this AUR package.

Solus

The latest stable release is available in the main repository:

Flatpak

The Xournal++ team officially supports a FlatHub release, which can be installed with

flatpak install flathub com.github.xournalpp.xournalpp

Notation that for Xournal++ to work properly, you lot must have at least i GTK theme and ane icon theme installed on Flatpak. To enable LaTeX support, you will also need to install the TeX Live extension:

flatpak install flathub org.freedesktop.Sdk.Extension.texlive

The Flatpak manifest can be found at the Xournal++ Flatpak packaging repository, and all Flatpak-related packaging issues should be reported there.

Android and Chrome Bone

Android is supported by Xournal++ Mobile. It can be downloaded either on the Tags page or from Google Play.

iOS

Unfortunately, the iOS app is not published withal in the Apple tree App Store. See here to acquire, why. Anyway, in the Building section y'all tin learn how to build an early preview.

Windows

Official Windows releases are provided on the Releases folio.

Mac Bone X

Mac Bone X releases are provided on the Releases page.

Notes:

There accept been compatibility issues with Mac Bone X Catalina regarding both file permissions and stylus support (#1772 and #1757). Unfortunately, nosotros don't have the resources to adequately support Catalina at this time. Assist would exist appreciated!
Xournal++ volition be delivered with a patched GTK. Else, force per unit area sensitivity will non work on Mac #569.

Edifice

Linux Build

Mac Build

Windows Build

Android Build

iOS Build

File format

The file format _.xopp is an XML which is .gz compressed. PDFs are non embedded into the file, so if the PDF is deleted, the groundwork is lost. _.xopp is basically the aforementioned file format as _.xoj, which is used by Xournal. Therefore Xournal++ is able to read _.xoj files, and tin besides export to _.xoj. As soon as notes are exported to a _.xoj-file, all Xournal++ specific extensions, like additional background types, are lost.

*.xopp can theoretically be read by Xournal, every bit long as you do non use any new feature. Xournal does not open up files that contain new attributes or unknown values, then Xournal++ will add the extension .xopp to all saved files to indicate the potential presence of Xournal++-only features.

All new files will be saved as _.xopp. If an _.xoj file that was created past Xournal is opened, the Salve-As dialog will be displayed on save. If the *.xoj file was created by Xournal++, the file will be overwritten on salve and the file extension volition not modify.

We are currently introducing a new file format that tin efficiently store attached PDF files and other attachments internally. We will still allow for attachments that are linked to external files. Please refer to #937 for further details.

Evolution

For developing new features, create an issue or comment on an existing upshot to let others know what you are doing. For evolution, create a fork and use the chief every bit base of operations. Create a pull asking for each fix. Do not create large pull requests, every bit long equally you don't break anything features likewise can be merged, even if they are not 100% finished.

Run across GitHub:xournalpp for current development. You tin can also join our Gitter aqueduct via the badge on tiptop.

Also accept a look at our coding conventions

Code documentation

The lawmaking documentation is generated using Doxygen.

In order to generate the documentation yourself, first install Doxygen and graphviz, i.eastward.

sudo apt install doxygen sudo apt install graphviz

on Debian or Ubuntu. Finally, execute doxygen in the root directory of the repository. The documentation can be institute in doc/html and doc/latex. Conveniently display the documentation with python3 -m http.server 8000 and visit the shown URL to view the documentation.