Skip to content

Commit 39f5f51

Browse files
readme updates
1 parent fe747c0 commit 39f5f51

File tree

1 file changed

+17
-37
lines changed

1 file changed

+17
-37
lines changed

README.md

Lines changed: 17 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -17,51 +17,31 @@ A plugin for Obsidian to draw circuits on a canvas.
1717

1818
## Installation
1919

20-
1. Clone the repository:
21-
```sh
22-
git clone https://github.com/code-forge-temple/circuit-sketcher-obsidian-plugin.git
23-
```
20+
1. Open [Obsidian](https://obsidian.md) and go to `Settings``Community Plugins``Browse`.
21+
2. Search for `Circuit Sketcher`.
22+
3. Select the `Circuit Sketcher` plugin and press `Install`.
2423

25-
2. Navigate to the project directory:
26-
```sh
27-
cd circuit-sketcher-obsidian-plugin
28-
```
24+
or
2925

30-
3. Set the Node.js version:
31-
- For Unix-based systems:
32-
```sh
33-
nvm use
34-
```
35-
- For Windows:
36-
```sh
37-
nvm use $(cat .nvmrc)
38-
```
39-
40-
4. Install dependencies:
41-
```sh
42-
npm install
43-
```
44-
45-
5. Build the project:
46-
```sh
47-
npm run build
48-
```
26+
1. Open [Community Plugins Page](https://obsidian.md/plugins?id=circuit-sketcher) in browser.
27+
2. Select `Install`.
4928

5029
## Usage
5130

52-
1. Copy the contents of the `./dist` folder (it contains the `circuit-sketcher` folder) into `<your Obsidian vault location>/.obsidian/plugins/`.
53-
2. Open Obsidian and go to `Settings``Community Plugins`. If you do not see `Circuit Sketcher`, press the `Installed plugins` refresh button, then activate the plugin.
54-
3. Use the ribbon icon or command palette to create a new circuit sketcher file.
55-
4. Start drawing your circuit on the canvas:
31+
1. Use the ribbon icon or command palette to create a new circuit sketcher file.
32+
2. Start drawing your circuit on the canvas:
5633
- On the canvas, right-click to show the canvas menu, and select `Create Node`.
57-
- Right-click on the node to show the node menu, and select `Change Image` and select an image relevant to your circuit node.
58-
- Right-click on the node to show the node menu, and select `Add Port` and select the port location and type.
59-
- 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).
60-
- 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-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).
34+
- Right-click on the node to show the node menu, select `Change Image`, and choose an image relevant to your circuit node.
35+
- Right-click on the node to show the node menu, select `Add Port`, and choose the port location and type.
36+
- 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).
37+
- 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.
38+
- 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).
6139
- You can reuse the node by right-clicking on the canvas and selecting `Add Node from Library`.
62-
- The connections between circuit nodes can be done by drag-and-dropping one port to the destination port (if it is a compatible port).
40+
- 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.
41+
42+
A short video tutorial on how to use the plugin:
6343

64-
https://github.com/user-attachments/assets/0fa80533-857d-47c8-913f-1f46e923117c
44+
[![S6ifgDb83Pg](https://img.youtube.com/vi/S6ifgDb83Pg/0.jpg)](https://www.youtube.com/watch?v=S6ifgDb83Pg)
6545

6646
## License
6747
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)