Add README

README.md

@@ -0,0 +1,67 @@
+# Kirdy Adapter
+Kirdy Adapter is a Butterfly Laser Diode Mount to be used with [Kirdy](https://git.m-labs.hk/sinara-hw/kirdy) mainboard.
+
+## Reproducible Project Outputs with Nix
+User can run the following commands to export all the project output including Gerber & Drill files, Bill of Materials file, Schematics PDF and Step 3D model.
+- `nix build .#LD_adapter_copper_plate`
+- `nix build .#LD_adapter_type_1_PCB`
+- `nix build .#LD_adapter_type_2_PCB`
+
+## Development Environment
+User can fetch the correct KiCad Version used in the project by running the following command.
+- `nix develop`
+
+## Laser Diode Adapter Type 1
+User can configure the following features by populating the corresponding jumper resistors:
+- Pinout of the laser mount
+- Bypass or use the Bias-T Network for injecting RF Modulation into the laser diode
+
+![Laser_Diode_Type_1_Pinout](./img/Laser_Diode_Type_1_Pinout.png)
+
+| Pin | Description |
+| --- | --- |
+| 1  | TEC+  |
+| 2  | NTC |
+| 3  | PD Anode |
+| 4  | PD Cathode |
+| 5  | NTC |
+| 6  | Not Connected |
+| 7  | PD Cathode* |
+| 8  | PD Anode* |
+| 9  | LD Cathode* |
+| 10 | LD Anode |
+| 11 | LD Cathode |
+| 12 | Not Connected |
+| 13 | LD Anode |
+| 14 | TEC- |
+
+*: Alternate LD/PD Connections.
+
+
+## Laser Diode Adapter Type 2
+User can configure the following features by populating the corresponding jumper resistors and capacitors:
+- Bypass or use the Laser Diode(if any) or PCB Bias-T Network for injecting RF Modulation into the laser diode
+
+![Laser_Diode_Type_2_Pinout](./img/Laser_Diode_Type_2_Pinout.png)
+
+| Pin | Description |
+| --- | --- |
+| 1  | NTC |
+| 2  | NTC |
+| 3  | LD Cathode |
+| 4  | PD Anode |
+| 5  | PD Cathode |
+| 6  | TEC+ |
+| 7  | TEC- |
+| 8  | Case (GND) |
+| 9  | Case (GND) |
+| 10 | Not Connected |
+| 11 | LD Anode |
+| 12 | Modulation Input |
+| 13 | LD Anode |
+| 14 | Not Connected |
+
+## Laser Diode Copper Heat Sink
+It is preinstalled with a thermal interface sheet for ease of installation of laser diode. The thermal interface sheet preinstalled is subject to change.
+
+Thermal Interface Sheet P/N: RS PRO 245-7321