From 4b9212872d079b5d064a58db6906d258586c1886 Mon Sep 17 00:00:00 2001 From: Sean Leavey Date: Mon, 12 Jan 2015 22:49:26 +0000 Subject: [PATCH] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a6cdc2e..41c3c12 100644 --- a/README.md +++ b/README.md @@ -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 `` 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.