Giter VIP home page Giter VIP logo

circuitversedocs's Introduction

The CircuitVerse logo

Financial Contributors on Open Collective CircleCI Status Coveralls Coverage Status

CircuitVerse is a free, open-source platform which allows users to construct digital logic circuits online. We also offer the Interactive Book which teaches users on the fundamentals of modern, digital circuits. Please also see our documentation or GitHub Wiki.

Community

We would love to hear from you! We communicate on Slack:

Slack

Code of Conduct

We follow the Code of Conduct of the CircuitVerse Community.

Setup

See SETUP.md for more information on setting up CircuitVerse.

Contributing

See CONTRIBUTING.md for more information on contributing to CircuitVerse.

License

This project is licensed under the MIT License.

circuitversedocs's People

Contributors

animesh-007 avatar ayan-biswas0412 avatar brahmakulkarni avatar capten101 avatar criticic avatar dev-pradhumna avatar fdila avatar gr455 avatar harsha-iiiv avatar harshagrwl avatar mohit-003 avatar monsij avatar murdock9803 avatar navonildas avatar nileshdas avatar palaksharma23 avatar pragatijain avatar pragativerma18 avatar pranay-simejia avatar ruhci28 avatar samriddhimishra avatar satu0king avatar schezfaz avatar shivansh2407 avatar shreyaprasad1209 avatar shubhankarkg avatar tachyons avatar umoren avatar vedant-jain03 avatar yashkumarverma avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

circuitversedocs's Issues

Pagination for interactive book.

I am submitting a -

  • [] Feature Request

Describe your bug/feature -

 It would be a better feature if there is pagination for direct to next or previous page.

Current behaviour -

No such a option currently.

Are you working on this issue? (Yes/No)

   Yes

Visualizing Timing Diagrams

I am submitting a -

  • Feature Request

Describe your bug/feature -

I want to write about how can we visualize the timing diagrams with the help of flags in circuitverse

Are you working on this issue? (Yes/No)

Yes

Live Circuit block not visible on small screens

I am submitting a -

  • [] Bug Report

Describe your bug/feature -

The live circuit and video block is not completely visible on small screens.

Current behaviour -

When the webpage is viewed on small screens( for example mobile phones), the live circuit and video block goes out of the screen and creates a poor user interface for the page.

Expected behaviour -

The video or the live circuit block should be completely visible to all the users on all screen sizes.

Screenshots (if relevant) -

WhatsApp Image 2019-03-23 at 7 05 21 PM

Are you working on this issue? (Yes/No)

Yes

Adding magnitude comparator (4 bit)

I am submitting a -

  • Feature Request

Describe your feature -

I will add docs on 4 bit magnitude or equality comparator usiing XNOR and AND gates.

Are you working on this issue? (Yes/No)

YESS

Add code of conduct

I am submitting a -

  • Feature Request

Describe your bug/feature -

Add code of conduct

Are you working on this issue? (Yes/No)

Yes

Document Input Elements

You will need to illustrate the various options of individual components and how to use it on CircuitVerse. Tips and tricks will be helpful.

  • Input
  • Button
  • Ground
  • Power
  • Constant
  • Stepper
  • Random
  • Counter

image

Documentation for TTY

I am submitting a -

  • [] Feature Request

Are you working on this issue? (Yes/No)

Yes

Simulation stack limit exceeded: maybe due to cyclic paths or connection

I am submitting a -

  • [] Bug Report

Describe your bug/feature - The simulator says "Simulation Stack Limit Exceeded: maybe due to cyclic paths or connection" when there are feedback circuits as seen in JK flipflop

Current behaviour - The 1 1 condition in clocked JK flipflop does not work

Expected behaviour - The circuit should work perfectly

Screenshots (if relevant) - h

Are you working on this issue? (Yes/No)

Yes

Documentation for Embeding circuits

I am submitting a -

  • Feature Request

Describe your bug/feature -

Create a page called Embed Circuits and add these

  1. How to generate the embed code.
  2. Using Embedded Code in the web page.

Are you working on this issue? (Yes/No)

Yes

HTML <input> Tag

The tag specifies an input field where the user can enter data.
elements are used within a

element to declare input controls that allow users to input data.
An input field can vary in many ways, depending on the type attribute.

Read more: https://www.w3schools.com/tags/tag_input.asp

Add Issue and Pull Request templates

I am submitting a -

  • Feature Request

Describe your bug/feature -
Currently there is no template for issue and pull request.

Are you working on this issue? (Yes/No)
Yes

Document Output Elements

You will need to illustrate the various options of individual components and how to use it on CircuitVerse. Tips and tricks will be helpful.

  • Output
  • RGBLed
  • LED
  • VariableLed
  • HexDisplay
  • SevenSegmentDisplay
  • SixteenSegmentDisplay
  • SquareRGBLed

image

CSS issues at multiple places, body width expanding more than vw.

I am submitting a -

  • [3] Bug Report and would like to SELF ASSIGN the issue

1. On the main landing Page the wrapper around the navigation extends view width and makes the body of the page expands more than 100%

img_1621

2. Star and Views tabs extends beyond the width will make it suitable and fit under the width

img_1620

3.(Not necessary but proposed change :) ) - I feel like search bar should be stacked on the top, thats a basic convention and a good UX/UI element

img_1619

Absence of 3 input AND gate

I am submitting a -

  • [] Feature Request

Describe your bug/feature - There should be a 3 input AND gate

Current behaviour - Only 2 input AND gates are available

Expected behaviour - Both 2 and 3 input AND gates should be available

Are you working on this issue? (Yes/No)

Yes

Documentation for test benches

I am submitting a -

  • Feature Request

Describe your bug/feature -

The current documentation does not addresses test benches.

Are you working on this issue? (Yes)

Major milestones

  • Test bench input
  • Test bench output

Improve Input element documentation

I am submitting a -

Feature Request

Describe your bug/feature -

Improve input elements docs

Current behaviour -

  • Missing embedded circuit for stepper
  • Wrong embedded circuit for counter
  • Missing Random input

Are you working on this issue? (Yes/No)

Yes

Real Time Chat feature needed in Docs.

I am submitting a -

  • Feature Request

Real time Chat feature like a button named as Open Chat needed in Official Documentation of CircuitVerse . When a student clicks on that button , it would automatically redirected to ongoing Gitter chat between mentor and various other GSOC students.

Screenshots (if relevant) -

realtimechat

Are you working on this issue? (Yes/No)

Yes

Add Quick Start

I am submitting a -

  • Feature Request

I am submitting a Quick Start Guide for the Circuit Verse Official Online Documentation.

Are you working on this issue? (Yes/No)

Yes

Minor Typo

I am submitting a -

  • Feature Request
  • Bug Report

guage --> gauge

Screenshots (if relevant) -

gauge

Are you working on this issue? (Yes)

I am interested to fix this, but as the Wiki is not directly editable, I think it has to be done on the maintainer side itself.

Adding docs for Subtractor

I am submitting docs for -

Half Subtractor
Full Subtractor

Are you working on this issue? (Yes/No)

Yes

Incorrect port number in readme.md

I am submitting a -

  • [] Bug Report

Describe your bug/feature -

   Incorrect port number for http

Current behaviour -

Expected behaviour -

Screenshots (if relevant) -

Are you working on this issue? (Yes/No)

yes

Documentation for Sequential Circuits

I am submitting a -

  • Feature Request
    I am adding the documentation of the sequential circuits.

Describe your bug/feature -

It will provide a brief introduction to the Sequential Circuit element of the Simulator.

Current behaviour -

Currently there is no documentation for the Sequential Circuits

Screenshots (if relevant) -

Screenshot_2019-03-24 Home - CircuitVerse Docs
I am currently working on this.

Are you working on this issue? (Yes/No)

Yes

Adding Adder Docs

I am submitting a -

  • Feature Request

I am adding docs for half and full adder.

Are you working on this issue? (Yes/No)

Yes

Add Docs For "Combinational Analysis"

Describe your bug/feature -

Add Documentation for Combinational Analysis tool which is present under the Tools tab.

Current behaviour -

Currently, documentation is not available for the same.

Are you working on this issue? (Yes/No)

Yes

Reorganize files

I am submitting a -

  • Feature Request

Describe your bug/feature -

Move documentation files in /docs folder, add a "real" README for the repo

Are you working on this issue? (Yes/No)

Yes

Image link was broken

I am submitting a -

  • [] Bug Report

Describe your bug/feature -

Image links were broken in 'Test Bench'

Current behaviour -

Not displaying any images

Expected behaviour -

Screenshots (if relevant) -

Screenshot (45)

Are you working on this issue? (Yes/No)

     No

Reading experience in dark theme

I am submitting a -

  • [] Feature Request

Describe your feature -

  Dark theme reading

Current behaviour -

Expected behaviour -

Screenshots (if relevant) -

Are you working on this issue? (Yes/No)

yes

Counter miss-documentation

The counter components "zero" output is activated when the counter overflows, and the clock cycle that overflowed the counter is still high. That is why when the max value is set to 0, it will always be high. The documentation does not cover this.

GSOC 2019 Project 5

@satu0king According to the Official GSOC-2019 list of project ideas of CircuitVerse , there is project on : Create informative material for digital logic design,
Design interactive circuits.
DIY digital logic design E-book . I want to work on this Idea and want to take part in GSOC-2019 .

MSB and LSB miss-documentation

The MSB and LSB components are using an input connected to their ENABLE pin, but the ENABLE pin is an output (active when the input is non-zero). This should be fixed ASAP.

Zoom Image on click

I am submitting a -

  • [] Feature Request

Describe your bug/feature -

Zoom in images on interactive book

Are you working on this issue? (Yes/No)

Yes

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.