Skip to content

Commit

Permalink
Adding information to documentation for setting the installation path…
Browse files Browse the repository at this point in the history
… if both Obsidian and Xournal++ are installed through Flatpack (Closes #2).
  • Loading branch information
jonjampen committed Oct 2, 2024
1 parent dd5318b commit d1332a5
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

All notable changes to this project will be documented in this file.

## [1.0.7] - 2024-10-

### Improved

- Added information to documentation for setting the installation path if both Obsidian and Xournal++ are installed through Flatpack.

## [1.0.6] - 2024-09-03

### Fixed
Expand Down
12 changes: 8 additions & 4 deletions docs/path.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,19 @@ Error: Xournal++ path not setup correctly. Please check docs on how to set it up
```

## Defaults

The defaults are the following:
- Linux: `xournalpp`
- Windows: `c:\Program Files\Xournal++\bin\xournalpp.exe`
- MacOS: `/Applications/Xournal++.app/Contents/MacOS/xournalpp`

- Linux: `xournalpp`
- Windows: `c:\Program Files\Xournal++\bin\xournalpp.exe`
- MacOS: `/Applications/Xournal++.app/Contents/MacOS/xournalpp`

By default, this plugin will try through all the above options.

## Manually Setting the Xournal++ Path

To manually set the Xournal++ installation path, open Obsidian and go to **Settings -> Xournal++** and set the path to whatever is right on your system.

### Find the Right Xournal++ Installation Path
To find the right installation path for your system, you need to find out where Xournal++ is installed to. On Windows you need to link to the `.exe` file, which is usually found in the `Program Files` folder. On MacOS you need to link to the `xournalpp` file inside a `.app` folder, usually within the `Applications` folder.

To find the right installation path for your system, you need to find out where Xournal++ is installed to. On Windows you need to link to the `.exe` file, which is usually found in the `Program Files` folder. On MacOS you need to link to the `xournalpp` file inside a `.app` folder, usually within the `Applications` folder. On Linux, if you have both Obsidian and Xournal++ installed through Flatpack, you can use `flatpak-spawn --host flatpak run com.github.xournalpp.xournalpp` as the installation path (more information: [Issue #2](https://github.com/jonjampen/obsidian-xournalpp/issues/2)).

0 comments on commit d1332a5

Please sign in to comment.