Skip to content

O
OHR Support

Project guidelines

Last edited by Erik van der Bij
Page history

Guidelines for OHWR administrators to create a project

Because of the bad searchability of the ohwr site and to keep things tidy, we have to be careful with a few things when creating projects. As when time passed by we found the best way to work with the tools, there are unfortunately some projects that don't stick to the rules.

  1. The project must present an interest to the community of electronics designers for experimental physics facilities
  2. Project Names should be meaningful and show main items
    • Simple VME FMC Carrier (SVEC)
    • USB Relay Box 1
    • FMC DAC 600M 12b 1cha DDS
  3. Project names should not have company names in it.
    • As a project is Open, it should not show its company. Having a neutral name will help to attract collaborators.
  4. FMC cards have a naming scheme for the identifier (/directory name)
    • This makes that in the project list those projects are sorted in a meaningful order.
    • FMC DIO 16ch TTL a, FMC ADC 250M 12b 2cha, FMC TDC 1ns 5cha etc.
  5. Subprojects
    • FMC projects should be subprojects of "FMC Projects".
    • HDL cores that are generally usable should be subprojects of the project "HDL Core Lib"
  6. Software projects belonging to a project are subprojects of the hardware project and have a specific name. E.g.:
    • Simple PCIe FMC carrier (SPEC)
      • Software support for the SPEC board
    • FMC DIO 32ch TTL a
      • Software support for FMC DIO 32CH TTL A

Erik van der Bij - 7 October 2013