Skip to content

docs: add KiCad library troubleshooting to README - #296

Merged
devbisme merged 1 commit into
devbisme:masterfrom
andrewhofmann:docs/add-kicad-library-troubleshooting
Apr 24, 2026
Merged

docs: add KiCad library troubleshooting to README#296
devbisme merged 1 commit into
devbisme:masterfrom
andrewhofmann:docs/add-kicad-library-troubleshooting

Conversation

@andrewhofmann

Copy link
Copy Markdown
Contributor

Summary

  • Adds a Troubleshooting section to the README covering the most common setup issue: KiCad symbol library path configuration
  • Includes OS-specific paths for Linux (package manager + Flatpak), macOS (Homebrew), and Windows
  • Provides a one-line verification command to confirm setup

Why

The #1 friction point for new users is KICAD_SYMBOL_DIR not being set or pointing to the wrong location. The current README mentions the variable but doesn't help users find the right path on their OS. This section provides copy-paste solutions for each platform.

Test plan

  • All listed paths verified against standard KiCad installations
  • Verification command works with a correctly configured environment

Add a Troubleshooting section covering the most common setup issue:
KICAD_SYMBOL_DIR not set or pointing to the wrong path. Includes
OS-specific paths for Linux, Flatpak, macOS, and Windows, plus a
one-line verification command.
@devbisme
devbisme merged commit e19d9a6 into devbisme:master Apr 24, 2026
@devbisme

Copy link
Copy Markdown
Owner

This was needed! Succinct, well-written, and verified. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants