Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #4

Open
dragetd opened this issue Dec 26, 2017 · 0 comments
Open

Add CONTRIBUTING.md #4

dragetd opened this issue Dec 26, 2017 · 0 comments

Comments

@dragetd
Copy link

dragetd commented Dec 26, 2017

Issue to track progress on writing a CONTRIBUTING.md :-)
A rough, initial plan has been written by ubitux already in #2 which was:

Here is a quick & dirty howto:

  • create boards/.scad following other .scad files in the same directory. This .scad is directly open-able with openscad.
  • if necessary, add the electronic components in electronics/.scad. The .scad files are directly open-able with openscad.
  • register the board in boards.scad (include of boards/.scad, mapping array to the info function, and the 2 modules entries)
  • create cases/.scad following other .scad files in the same directory (this one should be pretty simple). This .scad is directly open-able with openscad.
  • if your board has button pushers, you want to register it in cases/Makefile (BOARDS_WITH_BUTTON_PUSHERS)
  • make -j$(nproc) gif will generate the gif (it may take some time)
  • edit the .md files to add the necessary entries (board, cases, electronics).
    This step could be automatized, but it lacks a description to extract from somewhere. Maybe a // @desc or whatever in the .scad files or whatever could do the trick (extracted with a grep or whatever).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant