Skip to content

Commit f3797be

Browse files
robtaylorclaude
andcommitted
Fix CLAUDE.md documentation based on maintainer feedback
Address maintainer review comments on PR ra3xdh#1497: 1. Correct qucs2spice description - it's for library model format conversion, not general schematic-to-netlist conversion 2. Fix qucsator_rf description - it's a real RF simulator submodule, not an empty placeholder 3. Move flex/bison from required to optional dependencies (only needed for QucsatorRF) 4. Remove Q3ScrollView statement as it's deprecated 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 5d66230 commit f3797be

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

CLAUDE.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ make install
3939
Both options can be enabled simultaneously. Priority order: shared library → external process.
4040

4141
### Dependencies
42-
- **Required**: Qt6 (Core, Gui, Widgets, Svg, SvgWidgets, Xml, PrintSupport, Charts), CMake, flex, bison, gperf, dos2unix, C++20 compiler
42+
- **Required**: Qt6 (Core, Gui, Widgets, Svg, SvgWidgets, Xml, PrintSupport, Charts), CMake, gperf, dos2unix, C++20 compiler
4343
- **Runtime**: ngspice (primary simulation kernel, or libngspice if using shared library mode)
44-
- **Optional**: libngspice (for WITH_NGSPICE_SHARED)
44+
- **Optional**: libngspice (for WITH_NGSPICE_SHARED), flex/bison (only for QucsatorRF submodule)
4545

4646
### Running
4747
```bash
@@ -85,7 +85,7 @@ Components inherit from base Element class
8585
- Emits Qt signals to integrate with existing architecture
8686
- **xyce.cpp/h**: Xyce simulator support
8787
- **spicecompat.cpp/h**: SPICE compatibility layer
88-
- **qucs2spice.cpp/h**: Qucs schematic to SPICE netlist converter
88+
- **qucs2spice.cpp/h**: Library model format converter (converts Qucs-format models to SPICE format for library components)
8989

9090
### Visualization (`qucs/diagrams/`)
9191
- **diagram.cpp/h**: Base diagram/graph classes
@@ -196,13 +196,13 @@ Configuration in `.clangd` file.
196196

197197
### Simulation Flow
198198
1. User creates schematic in GUI
199-
2. Schematic converted to SPICE netlist (via `qucs2spice`)
200-
3. Netlist sent to simulation kernel (typically ngspice)
199+
2. Schematic components generate SPICE netlist
200+
3. Netlist sent to simulation kernel (typically ngspice via shared library or external process)
201201
4. Results parsed and visualized in diagrams
202202

203203
### Submodules
204-
- `qucsator_rf/` is a git submodule (currently empty placeholder)
205-
- Must run `git submodule init && git submodule update` after clone
204+
- `qucsator_rf/` is a git submodule containing the RF circuit simulator
205+
- Must run `git submodule init && git submodule update` after clone to populate it
206206

207207
## Common Tasks
208208

@@ -215,11 +215,11 @@ Configuration in `.clangd` file.
215215
### Debugging Build Issues
216216
- Check component library files in `library/` are installed
217217
- Verify Qt6 development packages present
218-
- Ensure flex/bison/gperf available for parser generation
218+
- Ensure gperf is available
219219
- Review CMake output for missing dependencies
220220

221221
### Working with Schematic Editor
222-
Key interaction code in `mouseactions.cpp` and `schematic.cpp`. Canvas uses custom Qt3-compatibility scroll view (`Q3ScrollView`).
222+
Key interaction code in `mouseactions.cpp` and `schematic.cpp`.
223223

224224
### Translation Updates
225225
Run with `-DUPDATE_TRANSLATIONS=ON` to update `.ts` translation files from source.

0 commit comments

Comments
 (0)