add README

This commit is contained in:
2025-04-09 12:46:26 +08:00
parent d69c8bca00
commit 15d80d3ff6

14
README.md Normal file
View File

@@ -0,0 +1,14 @@
# CoaXPress-SFP
SFP plugin with CoaXPress camera input
The uplink side relies on MGT Tx transceiver and needs custom firmware
The project is designed using KiCad 9
## 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 two renders (top-down and bottom-up) PNG.
- `nix build`
## Development Environment
User can fetch the correct KiCad Version used in the project by running the following command.
- `nix develop`