carbon-design-system/carbon-components-angular:README 來源編輯指南
根據 README、倉庫資料與授權整理 carbon-design-system/carbon-components-angular 的安裝與核驗路徑。
專案定位
carbon-design-system/carbon-components-angular 的 README 將專案描述為「An Angular implementation of the Carbon Design System for IBM.」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:An Angular implementation of the Carbon Design System。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Support」與相關條目,可以先判斷它是否處理你的實際問題:For things that are broken or need enhancement, open an issue。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:For general usage questions, or other discussions visit our Github Discussions。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「Getting started」等段落。可確認的線索包括:Next, we need to include carbon styles in src/styles.scss:。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: $ npx @angular/cli new my-project --style=scss $ cd my-project $ npm i --save carbon-components-angular @carbon/styles @carbon/icons 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Support」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Getting started」段落提到:Then we need to declare @carbon/icons as a module by creating a module.d.ts file (or use any existing declaration file - has .d.ts suffix) in your src directory:。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:IBMers should use our #carbon-ng Slack channel。
README 能確認的限制
README 能確認的限制比宣傳頁更重要。現有來源沒有證明carbon-design-system/carbon-components-angular具備固定相容矩陣、服務等級、效能基準或長期支援承諾。README 只明確寫到「That's it! Now we can run npm start and start building out our application!」。這些未知項應列入選型紀錄,不要改成肯定句。