📚 LibMan Documentation Index
June 24, 2026 · View on GitHub
Welcome! This is your central hub for all LibMan documentation. Use the sections below to find what you need.
🚀 Quick Links (What Do You Want to Do?)
| Goal | Document |
|---|---|
| I'm new here | Quick Start (5 min) |
| I want to build | Build guide · Dependencies |
| Set up VS Code | VS Code Setup Guide (10 min) |
| Need help fast | Quick Reference (2 min) |
| Customize tasks | Advanced Setup (15 min) |
| Troubleshoot | Troubleshooting Guide (5 min) |
| Verify setup | Verification Checklist (5 min) |
| File organization | Directory Structure (3 min) |
| Edit project file | Project Editor (5 min) |
| Import GDS/Xschem/Qucs/OAS | Import (5 min) |
| Schematic (Windows) | Xschem + WSL (10 min) |
📂 Documentation by Category
🎯 Getting Started (Read First!)
Quick guides to get you up and running:
- Quick Start - Start here if new
- Build guide - qmake vs CMake, Cap'n Proto, CI, Windows
- Dependencies - Install required libraries (⚠️ ZLIB needed)
- Setup Verification - Verify your setup
⚙️ Setup & Configuration
Detailed setup and configuration information:
- VS Code Setup - Complete VS Code configuration guide
- Directory Structure - Where everything is located
- CORE integration - Automatic fetch/build of CommonDB
- KLayout integration - Layout views, server, root cell selection
- Project Editor - Edit
define(library, path)entries (Ctrl+E) - Import - Convert GDS, Xschem, Qucs, OAS into CORE views (
File → Import...) - Xschem integration - Schematic/symbol on Windows via WSL launchers
📖 Reference & Advanced
Detailed reference and customization guides:
- Quick Reference Card - Keyboard shortcuts & common tasks
- Advanced Customization - How to customize build tasks
- Troubleshooting - Common issues and solutions
🎯 Getting Started (Steps)
For New Users:
- Read: Quick Start (5 minutes)
- Action: Install Dependencies (5-20 minutes)
- Build: Follow build instructions
- Success: Run the application
After Setup:
- Reference: Quick Reference for shortcuts
- Customize: Advanced Guide to customize tasks
- Troubleshoot: See Troubleshooting if issues arise
⚡ Quick Commands
# Build and run
Ctrl+Shift+B → Build & Run Debug
# Debug the app
F5 → Debug LibMan (GDB)
# Run tests
Ctrl+Shift+B → Tests: Run All Tests
# Quick help
Ctrl+Shift+P → "Tasks: Run Task"
📊 Documentation Statistics
- Total Pages: 12
- Getting Started: 3 pages
- Setup: 6 pages
- Reference: 3 pages
- Total Read Time: ~50 minutes (if reading all)
- Quick Start Time: ~5 minutes
🔗 External Resources
💡 Tips
- Bookmark this page for quick navigation
- Start with Quick Start if you're new
- Use Quick Reference for keyboard shortcuts
- Check Troubleshooting if something breaks
📞 Quick Help
Not finding what you need?
- Check the Quick Reference
- Look in Troubleshooting
- Review VS Code Setup
Last Updated: June 2026
For the main project README, see README.md