Skip to content

Contributing and License

Contributing

Everything is on GitHub: OSHE-Github/OSHE-PnP. Other OSHE projects and how to get involved: oshe.io.

  • Report a problem or suggest a change: open an issue.
  • Change something: fork, change, and open a pull request.
  • Run the tests first: pytest in Software/pnpvision and Software/Slicer.
  • Edit these docs: the pencil icon on every page opens the Markdown file on GitHub. To preview locally:
    py -3.14 -m pip install -r Documentation/requirements-docs.txt
    py -3.14 -m mkdocs serve -f Documentation/mkdocs.yml
    
    then open http://127.0.0.1:8000/ (Python 3.14 or older; details in Documentation/README.md). Run mkdocs build --strict before committing.

Repository layout

Folder Contents
CAD/ V3-Active, V2-Legacy, V1-Legacy (STEP, STL, 3MF)
BOMs/ bills of materials
Software/pnpvision/ machine software (Python)
Software/Slicer/ pnpslice (Python, Qt)
Software/Klipper/ Klipper and touchscreen configuration
Documentation/ these docs (docs/), sample images and data (samples/)
Media/ photos
Archive/ experiments and tools from earlier versions

License

What License
Hardware (CAD, BOM) CERN-OHL-S v2 (LICENSE-HARDWARE)
Software GPL-3.0 (LICENSE-SOFTWARE)
Documentation and media CC BY-SA 4.0

You may use, study, change and share the design. If you share a modified version, it must stay under the same licenses.

Third-party work

Used From License
Toolhead design basis LumenPnP by Opulo see Opulo's LumenPnP repository (compatibility with CERN-OHL-S being checked)
Feeder 0816 feeder by mgrl (mgrl.de), via a low-profile remix on MakerWorld, modified by us see the original project and the MakerWorld page
CoreXY layout inspired by Voron 2.3 (no parts copied) GPL-3.0
Firmware and host Klipper, Moonraker, Mainsail, KlipperScreen, crowsnest GPL-3.0
Light effects klipper-led_effect GPL-3.0
Legacy firmware Marlin GPL-3.0