Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SeanDS committed Jan 12, 2015
1 parent 90e1dd5 commit 4b92128
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Optivis uses a left-handed coordinate system in line with almost all computer gr
## Adding New Components ##
Optivis uses scalable vector graphics (SVGs) as a basis for its optical components. To add a new component, you must provide an SVG file describing the component's looks. Please use one of the existing files as a basis for your design - Optivis expects SVG files to have a specific format:
* The root element should be an `<svg>` item (this is standard for the SVG file format anyway).
* Elements and element attributes should not use namespaces (such as `i:midPoint="value"`, because namespaces are not defined in the header. This is to keep the files clean of program-specific crud, and ensure that generated SVG files are [valid](http://validator.w3.org/).
* Elements and element attributes should not use namespaces (such as `i:midPoint="value"`), because namespaces are not defined in the header. This is to keep the files clean of program-specific crud, and ensure that generated SVG files are [valid](http://validator.w3.org/).

The SVG file should be given an appropriate filename and placed in the `assets` directory within the `optivis` package. Then, in `optivis.bench.components` you should subclass the `AbstractComponent` class and write a constructor - see the existing components for details of how to do this. You will have to define nodes for your component's inputs and outputs. Nodes are places where links can originate or terminate, and must be positioned on the component's normalised coordinate system, where the origin is in the centre of the component. Again, see existing components for details.

Expand Down

0 comments on commit 4b92128

Please sign in to comment.