aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 38 insertions, 1 deletions
diff --git a/README.md b/README.md
index 81f493b..5314a9a 100644
--- a/README.md
+++ b/README.md
@@ -39,8 +39,45 @@ The board must have expansion port possibilites at least for low
speed extensions. With the ECP5 a 40GbE port is not possible as
the fpga does not have serdes at 10 Gigabit.
+### Tools ###
+
+The design is made with KiCad 9. The KiCad project is in `kicad/`, see
+`kicad/README.md`. The scripts that generate the project symbol libraries
+need kipart (`pipx install kipart`). Footprints and symbols are cross-checked
+against the JLCPCB/LCSC (EasyEDA) data with easyeda2kicad
+(`pipx install easyeda2kicad`).
+
+Optional: the KiCad MCP server `kicad-mcp-pro` lets an AI assistant such as
+Claude Code work with the KiCad project. Install it with pipx:
+
+ sudo apt install pipx
+ pipx ensurepath # then open a new terminal
+ pipx install kicad-mcp-pro
+
+The file `.mcp.json` in the repository root registers the server for this
+project, with `kicad/` as the project directory. Start Claude Code in the
+repository root so that `${PWD}` points there.
+
+### Reference designs ###
+
+eboard builds on ideas from two open ECP5 boards. No files are taken from
+them; they served as examples for the circuits. To look at them, clone them
+at the given commit (e.g. into `ext/`, which git ignores):
+
+| Design | Repository | Commit | Used as example for |
+|--------|------------|--------|---------------------|
+| ULX3S | <https://github.com/emard/ulx3s> | `6a92cec6` (2025-04-27) | one sheet per function, power supply (TLV62569), SDRAM, HDMI output with LVCMOS33D, GPIO without series resistors |
+| ButterStick | <https://github.com/butterstick-fpga/butterstick-hardware> | `0694ddf` (2023-09-19) | gigabit Ethernet (KSZ9031; eboard uses the RTL8211F), USB-C, FPGA core voltage |
+
+ git clone https://github.com/emard/ulx3s.git ext/ulx3s
+ git -C ext/ulx3s checkout 6a92cec6
+
### License ###
The hardware design files are licensed under CERN-OHL-S-2.0. The
software under GPL-3.0-or-later. All documents are licensed under
-CC-BY-SA-4.0. \ No newline at end of file
+CC-BY-SA-4.0.
+
+Exception: the manufacturer datasheets in `datasheets/` are copyrighted by
+their manufacturers and are not covered by these licenses (see
+`datasheets/README.md`). \ No newline at end of file