Skip to content

Commit 5df0cdf

Browse files
committed
Restored Icons
1 parent 68afcef commit 5df0cdf

2 files changed

Lines changed: 22 additions & 18 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ It works on supported JLCPCB, LCSC, Mouser, Farnell, element14, and Newark part
3232
</p>
3333
<br clear="left">
3434

35-
## Contents
35+
## <img src="docs/assets/readme/icon-contents.svg" alt="" width="20" height="20" align="absmiddle"> Contents
3636

3737
- [Installation](#installation)
3838
- [Quick start](#quick-start)
@@ -46,14 +46,14 @@ It works on supported JLCPCB, LCSC, Mouser, Farnell, element14, and Newark part
4646
- [Supporting docs](#supporting-docs)
4747
- [License and attribution](#license-and-attribution)
4848

49-
## Installation
49+
## <img src="docs/assets/readme/icon-installation.svg" alt="" width="20" height="20" align="absmiddle"> Installation
5050

5151
| Browser | Install from | Notes |
5252
|---|---|---|
5353
| Chrome, Edge, Brave, and other Chromium browsers | [Chrome Web Store](https://chromewebstore.google.com/detail/easyeda-downloader/egbkokdcahpjimldjjaobimnofbdnncb) | Full support for EasyEDA-backed pages and SamacSys-backed Mouser/Farnell/element14/Newark downloads. |
5454
| Firefox | [Firefox Add-ons](https://addons.mozilla.org/en-GB/firefox/addon/easyeda-downloader/) | Works for EasyEDA-backed pages. SamacSys-backed Mouser/Farnell/element14/Newark downloads need the optional Firefox relay setup. |
5555

56-
## Quick start
56+
## <img src="docs/assets/readme/icon-quick-start.svg" alt="" width="20" height="20" align="absmiddle"> Quick start
5757

5858
1. Open a supported JLCPCB, LCSC, Mouser, Farnell, element14, or Newark component page.
5959
2. Click the Easy ECAD Downloader extension icon.
@@ -62,7 +62,7 @@ It works on supported JLCPCB, LCSC, Mouser, Farnell, element14, and Newark part
6262
5. Click `Download`.
6363
6. Open the generated files from KiCad and review them before use.
6464

65-
## Usage walkthrough
65+
## <img src="docs/assets/readme/icon-walkthrough.svg" alt="" width="20" height="20" align="absmiddle"> Usage walkthrough
6666

6767
### 1. Open a supported component page
6868

@@ -88,7 +88,7 @@ Library mode creates a KiCad-style symbol library, footprint library, model fold
8888
<img src="docs/assets/readme/exportPreview.png" alt="KiCad 3D viewer export preview" width="760">
8989
</p>
9090

91-
## Output structure
91+
## <img src="docs/assets/readme/icon-output.svg" alt="" width="20" height="20" align="absmiddle"> Output structure
9292

9393
When `Save each file separately` is disabled, files are grouped under `Downloads/<library root>/`. The default library root is `easyECADDownloader`.
9494

@@ -118,14 +118,14 @@ Downloads/
118118

119119
When a footprint and matching 3D model are exported together, the footprint model reference is rewritten to the generated model path. If no 3D model is exported, stale model references are removed from the generated footprint.
120120

121-
## Supported sources and outputs
121+
## <img src="docs/assets/readme/icon-support.svg" alt="" width="20" height="20" align="absmiddle"> Supported sources and outputs
122122

123123
| Source flow | Pages | Symbol | Footprint | 3D model | Datasheet | Notes |
124124
|---|---|---:|---:|---:|---:|---|
125125
| EasyEDA-backed | JLCPCB, LCSC | Yes | Yes | When available | When available | Uses the detected LCSC id and upstream EasyEDA payload. |
126126
| SamacSys-backed | Mouser, Farnell, element14, Newark | Yes | Yes | When available | No | Downloads the upstream KiCad ZIP and repackages selected assets. |
127127

128-
## Settings
128+
## <img src="docs/assets/readme/icon-settings.svg" alt="" width="20" height="20" align="absmiddle"> Settings
129129

130130
<p align="center">
131131
<img src="docs/assets/readme/settingsPreview.png" alt="Easy ECAD Downloader settings page" width="760">
@@ -140,7 +140,7 @@ When a footprint and matching 3D model are exported together, the footprint mode
140140

141141
Password and token fields are blank when the settings page opens, and each field has a local show/hide button for checking typed values. New values are kept for the current browser session by default. Tick the relevant `Remember ... on this device` box only if you accept the risk of storing that secret in the browser profile.
142142

143-
## FAQ
143+
## <img src="docs/assets/readme/icon-faq.svg" alt="" width="20" height="20" align="absmiddle"> FAQ
144144

145145
<details>
146146
<summary><strong>View frequently asked questions</strong></summary>
@@ -284,7 +284,7 @@ Easy ECAD Downloader can only export files that are available from the source pa
284284

285285
</details>
286286

287-
## Technical overview
287+
## <img src="docs/assets/readme/icon-technical.svg" alt="" width="20" height="20" align="absmiddle"> Technical overview
288288

289289
<p align="center">
290290
<img src="docs/assets/readme/architectureDiagram.png" alt="Extension architecture overview" width="760">
@@ -302,21 +302,21 @@ Key implementation areas:
302302
- `src/kicad/`: EasyEDA parsing, KiCad emitters, shared conversion helpers, and OBJ-to-WRL conversion.
303303
- `tests/`: regression suite for behavior, conversion, browser runtime boundaries, and repository hygiene.
304304

305-
## Contributing
305+
## <img src="docs/assets/readme/icon-contributing.svg" alt="" width="20" height="20" align="absmiddle"> Contributing
306306

307307
Read [contributing.md](contributing.md) for development setup, local validation, contribution expectations, and manual extension-loading instructions. Read [AGENTS.md](AGENTS.md) for repository working rules.
308308

309309
Good contributions include parser fixes for real component pages, regression tests for failed exports, output-format corrections, browser compatibility fixes, and documentation that makes the workflow clearer for KiCad users.
310310

311-
## Supporting docs
311+
## <img src="docs/assets/readme/icon-docs.svg" alt="" width="20" height="20" align="absmiddle"> Supporting docs
312312

313313
- [systemDesign.md](systemDesign.md): design source of truth.
314314
- [CHANGELOG.md](CHANGELOG.md): notable changes by release or branch delta.
315315
- [SECURITY.md](SECURITY.md): vulnerability reporting and credential-handling notes.
316316
- [docs/architecture-notes.md](docs/architecture-notes.md): short implementation notes.
317317
- [docs/firefox-samacsys-proxy.md](docs/firefox-samacsys-proxy.md): Cloudflare Worker relay example for Firefox SamacSys support.
318318

319-
## License and attribution
319+
## <img src="docs/assets/readme/icon-license.svg" alt="" width="20" height="20" align="absmiddle"> License and attribution
320320

321321
This project includes and is derived from:
322322

tests/test_repo_hygiene.test.js

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,13 @@ const githubSlugForPlainHeading = (heading) =>
5959
.replace(/[^a-z0-9 -]/g, "")
6060
.replace(/\s+/g, "-");
6161

62+
const readmeHeadingText = (line) =>
63+
line
64+
.slice(3)
65+
.trim()
66+
.replace(/<img\s+[^>]*>\s*/g, "")
67+
.trim();
68+
6269
const CANONICAL_FOOTER = normalizeNewlines(
6370
[
6471
"/*",
@@ -298,7 +305,7 @@ describe("repository hygiene", () => {
298305
fs.readFileSync(path.join(REPO_ROOT, "README.md"), "utf8")
299306
);
300307
const contentsMatch = readmeText.match(
301-
/^## Contents\n\n((?:- \[[^\]]+\]\(#[^)]+\)\n)+)/m
308+
/^## (?:<img\s+[^>]*>\s*)?Contents\n\n((?:- \[[^\]]+\]\(#[^)]+\)\n)+)/m
302309
);
303310

304311
expect(contentsMatch).not.toBeNull();
@@ -312,11 +319,8 @@ describe("repository hygiene", () => {
312319
readmeText
313320
.split("\n")
314321
.filter((line) => line.startsWith("## "))
315-
.map((line) => line.slice(3).trim())
316-
.map((heading) => {
317-
expect(heading).not.toMatch(/<[^>]+>/);
318-
return githubSlugForPlainHeading(heading);
319-
})
322+
.map(readmeHeadingText)
323+
.map(githubSlugForPlainHeading)
320324
);
321325

322326
expect(linkedFragments).toEqual([...new Set(linkedFragments)]);

0 commit comments

Comments
 (0)