diff --git a/README.md b/README.md index f5bb8350..09432c68 100644 --- a/README.md +++ b/README.md @@ -141,7 +141,18 @@ Here are a few under development that you can play with now. The official releases of Xournal++ can be found on the [Releases](https://github.com/xournalpp/xournalpp/releases) page. We provide -binaries for Debian, Ubuntu, MacOS, and Windows. +binaries for Debian (Buster), Ubuntu (16.04), MacOS (10.13 and newer), and +Windows. For other Linux distributions (or older/newer ones), we also provide an +AppImage that is binary compatible with any distribution released around or +after Ubuntu 16.04. + +**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 20.04, the binary whose name +contains `Ubuntu-xenial` is _only_ compatible with Ubuntu 18.04. If your system +is not one of the specific Debian or Ubuntu versions that are supported by the +official binaries, we recommend you use either the PPA, the Flatpak, or the +AppImage. There is also an _unstable_, [automated nightly release](https://github.com/xournalpp/xournalpp/releases/tag/nightly) that @@ -160,7 +171,12 @@ sudo apt update sudo apt install xournalpp ``` -This PPA is provided by the Xournal++ team. +This PPA is provided by the Xournal++ team. While it has the latest features and +bug fixes, it has also not been tested thoroughly and may break periodically (we +try our best not to break things, though). + +We eventually also planning on setting up a PPA for stable releases +([#1013](https://github.com/xournalpp/xournalpp/issues/1013)). ### Fedora @@ -204,7 +220,7 @@ repository](https://www.archlinux.org/packages/?q=xournalpp). To build the latest state of the master branch yourself, use [this AUR package](https://aur.archlinux.org/packages/xournalpp-git/). -### Solus Linux +### Solus The latest stable release is available in the main repository: @@ -223,7 +239,12 @@ flatpak install flathub com.github.xournalpp.xournalpp ``` Note that for Xournal++ to work properly, you must have at least one GTK theme -and one icon theme installed on Flatpak. +and one icon theme installed on Flatpak. To enable LaTeX support, you will also +need to install the TeX Live extension: + +```bash +flatpak install flathub org.freedesktop.Sdk.Extension.texlive +``` The Flatpak manifest can be found at the [Xournal++ Flatpak packaging repository](https://github.com/flathub/com.github.xournalpp.xournalpp), and all @@ -231,19 +252,34 @@ Flatpak-related packaging issues should be reported there. ### Windows -**The windows Version has a Bug:** -Please start Xournal++, touch with the Pen, Quit Xournal++ and start again. -Then Pen input will be working, until you restart Windows. [#659](https://github.com/xournalpp/xournalpp/issues/659) +Official Windows releases are provided on the [Releases +page](https://github.com/xournalpp/xournalpp/releases). + +**Notes:** -https://github.com/xournalpp/xournalpp/releases +* Currently, only WinTab drivers are supported. This is due to a limitation with + the underlying library that we use, GTK. +* There is a GTK that prevents stylus input from working correctly. Please start + Xournal++, touch with the stylus, quit Xournal++ and start again. Then stylus + input will be working, until you restart Windows. See + [#659](https://github.com/xournalpp/xournalpp/issues/659). ### Mac OS X -Xournal++ will be deliverd with a patched GTK. Else pressure sensitivity is not -working on Mac [#569](https://github.com/xournalpp/xournalpp/issues/569). -(GTK-Issue) +Mac OS X releases are provided on the [Releases +page](https://github.com/xournalpp/xournalpp/releases). + +**Notes:** -https://github.com/xournalpp/xournalpp/releases +* There have been compatibility problems with Mac OS X Catalina regarding both + file permissions and stylus support + ([#1772](https://github.com/xournalpp/xournalpp/issues/1772) and + [#1757](https://github.com/xournalpp/xournalpp/issues/1757)). Unfortunately, + we don't have the resources to adequately support Catalina at this time. Help + would be appreciated! +* Xournal++ will be delivered with a patched GTK. Else pressure sensitivity may + not will not work on Mac + [#569](https://github.com/xournalpp/xournalpp/issues/569). ## Building