basic readme

README.md

@@ -0,0 +1,50 @@
+# openscad IDT creation scripts
+
+these are a collection of scripts and layout for creating IDTs within openscad as well as some fun
+layout on wafers. Currently these scripts only support bidirectional IDT but i will be adding more
+in the future. but you could create cool IDT on wafers like this:
+
+![alt text](image.png)
+
+
+## to start
+
+- download openscad
+```bash
+$ sudo apt install openscad
+```
+- clone this repo
+```bash
+$ git clone https://git.sirlilpanda.studio/sirlilpanda/openscad_parameteric_IDT_creation_scripts.git
+```
+- create a new openscad file within wafer layouts for this example it will be called `your_new_idt_layout.scad`
+```
+...
+|
+├ wafer_layouts
+|    ├ cross_pattern_idt.scad
+|    ├ hex_layout_idt.scad
+|    ├ pair_idt.scad
+|    ├ quadrant_array.scad
+|    ├ your_new_idt_layout.scad
+|    └ single_idt.scad
+├ common_params.scad
+└ README.md
+```
+- add the required files to get started in your `your_new_idt_layout.scad`
+``` scad
+// > your_new_idt_layout.scad
+// the idt module itself 
+include <../modules/bidirectional_idt.scad>
+
+// a module for nicely displaying the parameters used for your idt
+include <../modules/parameter_text.scad>
+
+// a simple wafer model that wont get added in to your final design
+include <../modules/wafer.scad>
+
+```
+- and lastly copy in the `common_params.scad` in to your `your_new_idt_layout.scad`, these are just common parameters that each design need such as frequency and speed of sound in your substrate.
+- now you can add as many idts to the wafer as you want.
+
+check out `single_idt.scad` and `quadrant_array.scad` to see what is possible with these scripts.