You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# circuit-sketcher-app
2
-
An application to draw circuits on a canvas, based on circuit-sketcher-core.
2
+
An application to draw circuits on a canvas. It is based on the [code-forge-temple/circuit-sketcher-core](https://github.com/code-forge-temple/circuit-sketcher-core).
3
3
4
4
## Table of Contents
5
5
@@ -9,7 +9,6 @@ An application to draw circuits on a canvas, based on circuit-sketcher-core.
9
9
-[Building](#building)
10
10
-[Linting](#linting)
11
11
-[Preview](#preview)
12
-
-[Usage](#usage)
13
12
-[Demo](#demo)
14
13
-[License](#license)
15
14
@@ -70,21 +69,23 @@ To preview the production build, run:
70
69
npm run preview
71
70
```
72
71
73
-
### Usage
74
-
75
72
## Usage
76
73
77
-
1. Open the app trough the `npm run preview` or `npm run dev` commands.
74
+
1. Open the deployed version of the application [here](https://code-forge-temple.github.io/circuit-sketcher-app).
78
75
2. Start drawing your circuit on the canvas:
79
76
- On the canvas, right-click to show the canvas menu, and select`Create Node`.
80
-
- Right-click on the node to show the node menu, and select`Change Image` and selectan image relevant to your circuit node.
81
-
- Right-click on the node to show the node menu, and select`Add Port` and selectthe port location and type.
82
-
- 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 go from there).
83
-
- After you are satisfied with your changes to the circuit node, and if you wish to save the circuit node to be able to reuse it in the current or a different circuit, you can right-click on the circuit node and press `Save Node to Library`.
77
+
- 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
+
- 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).
80
+
- 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.
81
+
- 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).
84
82
- You can reuse the node by right-clicking on the canvas and selecting `Add Node from Library`.
85
-
- The connections between circuit nodes can be done by drag-and-dropping one port to the destination port (if it is a compatible port).
83
+
- 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.
84
+
- You can drag the entire circuit by holding the mouse scroll button and moving the mouse.
85
+
86
+
A short video tutorial on how to use the application (the video is showcasing the Obsidian plugin version of the Circuit Sketcher but the core functionality is the same):
0 commit comments