Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Gif to getting_started.md #288

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@

## Creating a Circuit Element

<video style="width:100%; height: 400px;" controls>
<source src="/video/drag.mp4" type="video/mp4"> Sorry, your browser doesn't support embedded videos.
</video>
<img style="width:100%; height: 400px;" alt="drag-circuitverse" src="/docs/gif/drag-circuitverse.gif" />

Select the circuit element type and drop on canvas or drag the object onto canvas.

Expand All @@ -16,30 +14,22 @@ Select the circuit element type and drop on canvas or drag the object onto canva

1. Click one node and simply drag the mouse to the other node.

<video style="width:100%; height: 400px;" controls>
<source src="/video/clickwire.mp4" type="video/mp4"> Sorry, your browser doesn't support embedded videos.
</video>
<img style="width:100%; height: 400px;" alt="clickwire-circuitverse" src="/docs/gif/clickwire-circuitverse.gif" />

2. Hold down `Ctrl`, click on a node and simply move the cursor to the final node to which it needs to be attached. Clicking on the wire will insert a node at that position.

<video style="width:100%; height: 400px;" controls>
<source src="/video/ctrlclickwire.mp4" type="video/mp4"> Sorry, your browser doesn't support embedded videos.
</video>
<img style="width:100%; height: 400px;" alt="ctrlclickwire-circuitverse" src="/docs/gif/ctrlclickwire-circuitverse.gif" />

Upon reaching the final node, let go of `Ctrl` and simply click on the node to end the wire.

## Multiple Object Selections

<video style="width:100%; height: 400px;" controls>
<source src="/video/multiselectionDrag.mp4 " type="video/mp4"> Sorry, your browser doesn't support embedded videos.
</video>
<img style="width:100%; height: 400px;" alt="multiselectionDrag-circuitverse" src="/docs/gif/multiselectionDrag-circuitverse.gif" />

Hold down shift key and drag to make a selection

## Property Menu

<video style="width:100%; height: 400px;" controls>
<source src="/video/properties.mp4 " type="video/mp4"> Sorry, your browser doesn't support embedded videos.
</video>
<img style="width:100%; height: 400px;" alt="properties-circuitverse" src="/docs/gif/properties-circuitverse.gif" />

Select the object to see and change its properties.
Select the object to see and change its properties.
Binary file added docs/gif/clickwire-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/ctrlclickwire-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/drag-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/multiselectionDrag-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/properties-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/test_bench-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/wire-circuitverse.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.