Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (27 loc) · 1.75 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.75 KB

Contribution Guidelines

This project is linked to the Pluto.jl project, please refer to its contribution guidelines as well.

Building from source

  • Download and install NodeJS v22 or later
  • Run npm i and then npm run package. This should provide you with an installer execuatble in release/build folder.
    • MacOS is currently only supported in development mode (npm run start), because Code Signing is broken. We could get it to work with a Developer ID certificate?

Development setup

Just a couple of steps!

  • Download and install NodeJS v22 or later
  • cd into the folder
  • run npm install
  • run npm run package (this will download Julia into the right location)

After the initial setup:

Run in development mode

  • run npm run start

Node: Currently the code has some Windows-specific parts, such as checking for admin rights etc.

Working with Pluto.jl

It is expected that those working on both Pluto.jl and PlutoDesktop will place them in the same parent directory. By default, PlutoDesktop will serve Pluto.jl assets from ../Pluto.jl/frontend in development mode.

Updating versions

Pluto version:

In a Windows terminal, go to assets/env_for_julia, run Julia (of the same version that is used in the app) and modify the environment. E.g. pkg> update. Git commit the changes to Manifest.toml.

Julia version

Modify the Julia version in the bundler/scripts/beforePack.js file. Git commit and push.

npm versions

npm update

Contributing

See if there already exists and issue or an open PR against the issue you are trying to solve. If there isn't any, create a new issue.