symbench / electric-circuits

Electric Circuits Domain for webGME
https://webgme.symbench.org
Apache License 2.0
12 stars 3 forks source link

Adding a new Component #146

Open umesh-timalsina opened 3 years ago

umesh-timalsina commented 3 years ago

There are many moving pieces to this repository. Adding a new component can easily overlook some steps needed for a fully functional steps. It might be good to document what's needed to add a new component. In this issue(Or hopefully a new long living markdown file), we can keep track of what's needed to add a new component to this repository: Basically, with the current setup adding a new component requires following:

  1. Creating metanode for the component.
  2. After #141 and #64, creating a DeviceModel for the compoenent.
  3. Defining decorator Icons for the component
  4. Defining jointJS Icon/ Elmement with Ports to for the component.
  5. Adding component support in ConverCircuitToNetlist and ConvertNetlistToCircuit and RecommendNextComponent plugins.

It might be nice to further streamline this process such that it is less cumbersome to add a new component.