tscircuit/tscircuit:README 來源編輯指南
根據 README、倉庫資料與授權整理 tscircuit/tscircuit 的安裝與核驗路徑。
專案定位
tscircuit/tscircuit 的 README 將專案描述為「Create real electronics with Typescript and React」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「tscircuit - React for Circuits」下寫到:Make electronics using Typescript, React, and AI tools.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「More Features!」與相關條目,可以先判斷它是否處理你的實際問題:[x] Publish subpackages to the registry with tsci push。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:[x] Export Gerbers, Pick'n'Place and BOM for manufacturing。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「tscircuit - React for Circuits」等段落。可確認的線索包括:Get started by running npm install -g tscircuit! (CLI quickstart doc)。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: npm install -g tscircuit tsci dev 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「What is tscircuit?」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「What is tscircuit?」段落提到:tscircuit is a library complemented by a registry, package manager, command line tool and AI electronic design suite that makes it easy to create, share, export and manufacture electronic circuits.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:[x] Simplified, extensible auto-routing for PCBs。
README 能確認的限制
README 能確認的限制比宣傳頁更重要。現有來源沒有證明tscircuit/tscircuit具備固定相容矩陣、服務等級、效能基準或長期支援承諾。README 只明確寫到「Think of tscircuit as "React for Electronics" It allows you to design real-world electronic circuits using Typescript and React. This is what tscircuit code looks like, instead of creating web element like "div", you create circuit」。這些未知項應列入選型紀錄,不要改成肯定句。