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

Refined Key Features Section for Better Readability and Professionalism #396

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
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
6 changes: 3 additions & 3 deletions docs/chapter1/2keyfeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ This section shares key features of the CircuitVerse simulator.

<div align="center"><em>Figure 1.4: Some of the key features of the CircuitVerse simulator</em></div>

1. **Build and simulate your circuits in the cloud**: Create and run your simulations in your browser without the hassle of software installation or operating system dependent instructions. Since the process of circuit creation and simulation is seamless, users can edit and troubleshoot their circuit design or apply changes while the simulation is running. Users can save and open their circuits online (against the user’s dashboard) or offline (locally on their machine).
1. **Build and simulate your circuits in the cloud**: Create and run your simulations in your browser without the hassle of software installation or operating-system-dependent instructions. Since the process of circuit creation and simulation is seamless, users can edit and troubleshoot their circuit design or apply changes while the simulation is running. Users can save and open their circuits online (against the user’s dashboard) or offline (locally on their machine).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is good


2. **Transform your ideas using a powerful, intuitive and interactive schematic editor**:

- **Design using an easy-to-use interactive schematic editor**: As users drag and drop circuit elements on the canvas, horizontal and vertical wires can be drawn to complete the circuit connections. The wires are color coded to test and analyze the circuit simulations with ease.
- **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
- **Design supports multibit wires (buses)**: Every input and output circuit element has a bit width associated with it. Most of the CircuitVerse components include attributes allowing you to customize the bit widths of their inputs and outputs. CircuitVerse supports multibit wires across two components demanding multi bit widths. As needed, splitters can also be used to direct bits in different directions.
- **Design supports multibit wires (buses)**: Every input and output circuit element has a bit width associated with it. Most of the CircuitVerse components include attributes allowing you to customize the bit widths of their inputs and outputs. CircuitVerse supports multibit wires across two components demanding multibit widths. As needed, splitters can also be used to direct bits in different directions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

multi-bit


3. **Insert subcircuit**: Hierarchical circuits can be created by nesting and reusing smaller circuits in larger circuits (something like this). No need to mention verilog here.

4. **Export images in multiple formats**: High-resolution CircuitVerse images can be exported in multiple formats for different views and background options.

5. **Visualize circuit simulations using timing diagram**: Timing diagrams can be used to analyze and debug the behavior of circuits for different input sequences. debug logical mistakes and race conditions. Timing diagrams can be paired with the Flag circuit element to explain different concepts such as propagation delay, stable state and race conditions.
5. **Visualize circuit simulations using timing diagram**: Timing diagrams can be used to analyze and the behavior of circuits for different input sequences. To debug logical mistakes and race conditions. Timing diagrams can be paired with the Flag circuit element to explain different concepts such as propagation delay, stable state and race conditions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You forgot a debug here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole paragraph needs improvement , gramatically correct but broken.
Take documentation suggestions from gpt


6. **Embed simulations across webpages and presentations**: Since the CircuitVerse webpages are structured using HTML5, an iframe can be generated for embedding each CircuitVerse simulation within web pages. Alternatively, users can download the CircuitVerse Chrome extension for embedding live CircuitVerse circuits within a Google Slides presentation.

Expand Down