Skip to content

Commit a884b1b

Browse files
readme + core package version updates
1 parent fe2b20a commit a884b1b

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# 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).
33

44
## Table of Contents
55

@@ -9,7 +9,6 @@ An application to draw circuits on a canvas, based on circuit-sketcher-core.
99
- [Building](#building)
1010
- [Linting](#linting)
1111
- [Preview](#preview)
12-
- [Usage](#usage)
1312
- [Demo](#demo)
1413
- [License](#license)
1514

@@ -70,21 +69,23 @@ To preview the production build, run:
7069
npm run preview
7170
```
7271

73-
### Usage
74-
7572
## Usage
7673

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).
7875
2. Start drawing your circuit on the canvas:
7976
- 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 select an image relevant to your circuit node.
81-
- Right-click on the node to show the node menu, and select `Add Port` and select the 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).
8482
- 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):
8687
87-
https://github.com/user-attachments/assets/d925566b-9a07-417f-94ad-ebb5e09c4ffb
88+
[![S6ifgDb83Pg](https://img.youtube.com/vi/S6ifgDb83Pg/0.jpg)](https://www.youtube.com/watch?v=S6ifgDb83Pg)
8889
8990
## Demo
9091
You can view the deployed version of the application [here](https://code-forge-temple.github.io/circuit-sketcher-app).

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)