Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

26 lines (23 loc) · 2.44 KB

Contributing to UC2

Get Involved

This project is open so that anyone can get involved. You don't even have to learn CAD designing or programming. Ways you can contribute include:

  • General / Documentation
    • Share your results - setups you've built or things you've seen with them - on Twitter using #openUc2
    • Get involved in discussions in the ISSUE-section.
    • Raise an issue if you spot something that's wrong, or something that could be improved. This includes the instructions/documentation.
    • Suggest better text or images for the instructions.
    • Fork it, and make pull requests - documentation improvements are every bit as useful as a new design or software improvement.
  • Hardware / Design
    • We support you with the basic CAD design files, so that you can develop specific hardware-function which can fit in our cubes.
    • We provide a brief tutorial on how to design an insert which adapts any part to the UC2 system. Please find it here on how to design an insert in Inventor.
    • Improve the design of parts STL files or descriptions of changes are helpful, even if you don't use OpenSCAD or Inventor.
  • Software
    • Our software-oriented UC2-SOFTWARE-GIT provides you with all the different programs that you need to automate your blocks.
    • Run our GUI on RasPi or Android-Phone.
    • Setup your Arduino or ESP32.
    • We want to generalize our Software to even integrate more with community standards and have an overall compatibility with different Operating Systems. Get INVOLVED by:
      • switching to a new browser-based GUI
      • improving our MQTT based connection routines and trying to improve the necessary hardware-flashes
      • adding totally unknown functions
      • making our Software as modular as possible
  • Things in need of attention are currently described in issues so have a look there if you'd like to work on something but aren't sure what.