Skip to content

Commit 69d80fe

Browse files
added reference to circuit-sketcher-lib
1 parent 3bf5765 commit 69d80fe

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ A plugin for Obsidian to draw circuits on a canvas. It is based on the [code-for
1212
- [Features](#features)
1313
- [Installation](#installation)
1414
- [Usage](#usage)
15+
- [Component Library](#component-library)
1516
- [License](#license)
1617

1718
## Features
@@ -39,17 +40,32 @@ or
3940
2. Start drawing your circuit on the canvas:
4041
- On the canvas, right-click to show the canvas menu, and select `Create Node`.
4142
- Right-click on the node to show the node menu, select `Change Image`, and choose an image relevant to your circuit node.
42-
- Right-click on the node to show the node menu, select `Add Port`, and choose the port location and type.
43+
- Right-click on the node to show the node menu, select `Add Port...`, and choose the port location and type.
4344
- You can rename the circuit node label or port label by double-clicking on the label. The port or port label can also be deleted (right-click on the port to show the port menu and proceed from there).
4445
- You can relocate ports, either to a different node side or rearrange the ports on the same side, by dragging and dropping the port to the desired location within the dotted blue area.
4546
- After you are satisfied with your changes to the circuit node, and if you wish to save the circuit node to reuse it in the current or a different `.circuit-sketcher` file, you can right-click on the circuit node and press `Save Node to Library` (this will update the root Obsidian vault `circuit-sketcher.lib` file).
46-
- You can reuse the node by right-clicking on the canvas and selecting `Add Node from Library`.
47+
- You can reuse the node by right-clicking on the canvas and selecting `Library...` then selecting the desired node.
4748
- Connections between circuit nodes can be made by dragging and dropping one port to the destination port (if it is a compatible port). You can delete a connection by selecting it and then pressing the Delete key.
4849
- You can drag the entire circuit by holding the mouse scroll button and moving the mouse.
4950

5051
A short video tutorial on how to use the plugin:
5152

5253
[![S6ifgDb83Pg](https://img.youtube.com/vi/S6ifgDb83Pg/0.jpg)](https://www.youtube.com/watch?v=S6ifgDb83Pg)
5354

55+
## Component Library
56+
57+
To help you get started with Circuit Sketcher, we provide a curated library of circuit components at [circuit-sketcher-lib](https://github.com/code-forge-temple/circuit-sketcher-lib).
58+
59+
### Quick Start with Pre-built Components
60+
61+
**Import the entire library:**
62+
- Download the complete component library: [library.json](https://github.com/code-forge-temple/circuit-sketcher-lib/blob/main/assets/lib/library.json)
63+
- Import it directly into Circuit Sketcher to get access to all available components (right click on canvas to show the menu, then `Library...` -> `Import Library`)
64+
65+
**Import individual components:**
66+
- Browse individual components: [assets/nodes](https://github.com/code-forge-temple/circuit-sketcher-lib/tree/main/assets/nodes)
67+
- Download specific `.json` files for the components you need
68+
- Import them one by one into your Circuit Sketcher workspace (right click on canvas to show the menu, then `Import Node`)
69+
5470
## License
5571
This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more details.

0 commit comments

Comments
 (0)