Skip to content

Commit 3895aa3

Browse files
added reference to circuit-sketcher-lib
1 parent d968b9e commit 3895aa3

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
@@ -10,6 +10,7 @@ An application to draw circuits on a canvas. It is based on the [code-forge-temp
1010
- [Linting](#linting)
1111
- [Preview](#preview)
1212
- [Demo](#demo)
13+
- [Component Library](#component-library)
1314
- [License](#license)
1415

1516
## Features
@@ -75,11 +76,11 @@ npm run preview
7576
2. Start drawing your circuit on the canvas:
7677
- On the canvas, right-click to show the canvas menu, and select `Create Node`.
7778
- Right-click on the node to show the node menu, select `Change Image`, and choose an image relevant to your circuit node.
78-
- Right-click on the node to show the node menu, select `Add Port`, and choose the port location and type.
79+
- Right-click on the node to show the node menu, select `Add Port...`, and choose the port location and type.
7980
- 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).
8081
- 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.
8182
- 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).
82-
- You can reuse the node by right-clicking on the canvas and selecting `Add Node from Library`.
83+
- You can reuse the node by right-clicking on the canvas and selecting `Library...` then selecting the desired node.
8384
- 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.
8485
- You can drag the entire circuit by holding the mouse scroll button and moving the mouse.
8586
@@ -90,5 +91,20 @@ A short video tutorial on how to use the application (the video is showcasing th
9091
## Demo
9192
You can view the deployed version of the application [here](https://code-forge-temple.github.io/circuit-sketcher-app).
9293
94+
## Component Library
95+
96+
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).
97+
98+
### Quick Start with Pre-built Components
99+
100+
**Import the entire library:**
101+
- Download the complete component library: [library.json](https://github.com/code-forge-temple/circuit-sketcher-lib/blob/main/assets/lib/library.json)
102+
- 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`)
103+
104+
**Import individual components:**
105+
- Browse individual components: [assets/nodes](https://github.com/code-forge-temple/circuit-sketcher-lib/tree/main/assets/nodes)
106+
- Download specific `.json` files for the components you need
107+
- Import them one by one into your Circuit Sketcher workspace (right click on canvas to show the menu, then `Import Node`)
108+
93109
## License
94110
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)