Which build instructions to follow?

In the README, under "Contributing", there's a link that points to /readme/dev/index.md. That file has a link that points to /readme/dev/BUILD.md. But aren't I supposed to follow the instructions in BUILD.md in the root of the master branch? Personally I had no luck compiling with either :frowning:

The latest development code is on the dev branch. BUILD.md should also be available on the Joplin website: Building the applications | Joplin .

Some users have had trouble compiling with the Devbox-related instructions. I'm including a few related notes:

  • I would suggest against using Devbox on Windows, as it requires WSL.
  • If on Linux or MacOS, it's possible to manually install the build dependencies listed in the Devbox config (for example, with dnf install nodejs pixman ...). This is what I've done for my build environments on Windows, MacOS, and Linux.

If you're having trouble with a specific error, please let us know!

1 Like

Thanks for the reply.

The placeholder (in the textbox) when creating a post in the "Development" category has a link to BUILD.md on the master branch. That lead me to devote unnecessary time following the wrong build instructions. I hope this link can get fixed.

And I got it to compile, but only by after adding giflib@latest to devbox. I had no other issues with the build process.

1 Like

Thank you for reporting that! It should now be fixed.

1 Like