Skip to content

INDEX.md

Latest commit

 

History

History
131 lines (92 loc) · 4.51 KB

INDEX.md

File metadata and controls

131 lines (92 loc) · 4.51 KB
Raw

📚 LibMan Documentation Index

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 · Qucs-S

📂 Documentation by Category

🎯 Getting Started (Read First!)

Quick guides to get you up and running:

  1. Quick Start - Start here if new
  2. Build guide - qmake vs CMake, Cap'n Proto, CI, Windows
  3. Dependencies - Install required libraries (⚠️ ZLIB needed)
  4. Setup Verification - Verify your setup

⚙️ Setup & Configuration

Detailed setup and configuration information:

  1. VS Code Setup - Complete VS Code configuration guide
  2. Directory Structure - Where everything is located
  3. CORE integration - Automatic fetch/build of CommonDB
  4. KLayout integration - Layout views, server, root cell selection
  5. Project Editor - Edit define(library, path) entries (Ctrl+E)
  6. Import - Convert GDS, Xschem, Qucs, OAS into CORE views (File → Import...)
  7. Xschem integration - Schematic/symbol on Windows via WSL launchers
  8. Qucs-S integration - Schematic/symbol in Qucs-S + ngspice on Windows

📖 Reference & Advanced

Detailed reference and customization guides:

  1. Quick Reference Card - Keyboard shortcuts & common tasks
  2. Advanced Customization - How to customize build tasks
  3. Troubleshooting - Common issues and solutions

🎯 Getting Started (Steps)

For New Users:

  1. Read: Quick Start (5 minutes)
  2. Action: Install Dependencies (5-20 minutes)
  3. Build: Follow build instructions
  4. Success: Run the application

After Setup:

  1. Reference: Quick Reference for shortcuts
  2. Customize: Advanced Guide to customize tasks
  3. 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?

Last Updated: June 2026

For the main project README, see README.md