circuitverse / circuitversedocs Goto Github PK

CircuitVerse Online Documentation

Home Page: http://docs.circuitverse.org/

circuitversedocs's Introduction

CircuitVerse Documentation

This is the official documentation of the CircuitVerse simulator. This is meant to be a guide for users to use CircuitVerse. This contains the details of the usage of all Circuit Elements in CircuitVerse along with some tips and tricks. This guide assumes that the user has the minimum required knowledge.

Note : This is not a documentation on digital logic design. If you are interested in that, please checkout the GSoC'20 link at the end

Cloning Instructions

Note : If you want to contribute, first fork the original repository and clone the forked repository into your local machine followed by cd into the directory

git clone https://github.com/<your-username>/CircuitVerseDocs.git
cd CircuitVerseDocs

Local Deployment for testing

To view the docs in offline mode, navigate to /docs folder and run python3 -m http.server (for python3.x) or python -m SimpleHTTPServer 8000 (for python2.x) or python -m http.server

When you add a page, make sure you have an entry in the _sidebar.md

Note : All the documentation should have a corresponding live circuit embedded so as to help the users. Also, the live circuit is NOT the same as image of a circuit.

Installation on Netlify

Go to https://app.netlify.com and register an account
Click New site from Git or go to https://app.netlify.com/start
Click GitHub and authorise Netlify to view all your repositories or just the repository that you would like to publish
- You will need to be the owner of the repository as Netlify needs to add a webhook and deploy key. You can get around this by forking the repository and publishing that instead
Click Deploy site (you do not need to change any settings other than maybe branch)

Steps for Contributing

Fork this project
Clone your version of repository locally.
Create your feature branch (git checkout -b feature/feature_name)
Commit your changes (git commit -am 'Add feature')
Push to the branch (git push origin feature_name)
Create a new Pull Request

Prerequisites for using the CircuitVerse Simulator

Getting started with using the CircuitVerse Simulator requires some basic knowledge of the following aspects/concepts:

Basic concepts of number system (Decimal, Binary).
- Get to know about Binary, Decimal, Octal and many more systems.
Knowledge of electronic circuits/elements (Logic Gates, basic Input and Output elements etc).
- Learn the basics about Logic gates.
- Some Input Elements and Output Elements guide to get you started.
Basic concepts of circuit theory.

Code of Conduct

Read the Code of Conduct of our CircuitVerse community regarding contributing in the Documentation.

GSoC'20 Project Details

Interactive Book

The primary goal is to develop an opensource book which teaches digital logic design. This means that professors and students all over the world should read and contribute to the same. The book should make little assumptions about the knowledge of the reader.

Read the wiki for more information on the interactive book.

circuitversedocs's People

Contributors

Stargazers

Watchers

Forkers

satu0king zense jing-xuan moshtica qihanghuang phurijit akoopraba4 kedar-k nirmalkumarjoshi agarwalrounak yagnik112358 dev-pradhumna sarahbornais cipherghost harsha-iiiv jameskolney2 kartikeya71 iamnamankhare areeshatariq tabish1109 ritaban-datta creyente1897 monilbhavsar navonildas jerrybuks saumyashrm2802 aakash-dd saurabh111121 amansingla97 apurbapaul1998 moussaabben keven-zhu profphillips sahaj8 manudiy tusshartms k998 sal2701 cemtener chauxvive zcapshaw codesarthak anubhavmadhav criticic joshuapoddoku vikassharma1999 deepak2431 sachin235 dev9414 sakshi1499 pragativerma18 shweta0002 sgpritam ashiscs mikolajhojda fencer19 fr3ekout parikshit-hooda bluetimer jyothsnaashok joshheng vijayadhithya nrs1729 pra41 mohit-003 qualitytrash abdelkarimjaja arraxx samriddhimishra msrivastava dushyant19 syntaxhacker sd8917 rolodexx thisispratt nileshdas rana-elkhouly swarali15 hari-07 mahmodhammad shoaibmircom shubhankarkg marcelopalacioabreu ganeshcet20 alabs02 ananthavijay girish05962 go-row animesh-007 nitin10s shivansh2407 vanshvarshney naman360 yashkumarverma mostafa-elsharnoby schezfaz capten101 aniket328 adityatiwari23 uddit9058

circuitversedocs's Issues

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

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.

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.

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.

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

Discussion Forum needed for Students to clarify their doubts with Teachers.

I am submitting a -

Feature Request
Discussion Forum is needed in CircuitVerse Docs in order to clarify doubts regarding assignments and circuits etc.

ScreenShots -

For Example -

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

Yes

Documentation for Keyboard

I am submitting a -

[] Feature Request

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

Yes

Documentation required for Combinational Circuits

I am submitting a -

Feature Request
Documentation required for combinational circuits

Screenshots (if relevant) -

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) -

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

Yes

Document RAM, ROM, EEPROM

Create a page called memory elements and add documentation for these

ROM
RAM
EEPROM

Helpful links

CircuitVerse/CircuitVerse#229
CircuitVerse/CircuitVerse#113

Documentation required for Flag, Tunnel, Buffer, Tristate, Controlled Inverter (Miscellaneous elements)

I am submitting a -

[] Feature Request

Describe your bug/feature -

Documentation for only miscellaneous elements (except ALU and ADDER) is not available. So I will add a documentation on Flag.Text,Arrow,Rectangle and Tunnel

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

YESS

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.

Document Misc

ALU
Adder

Documentation for Embeding circuits

I am submitting a -

Feature Request

Describe your bug/feature -

Create a page called Embed Circuits and add these

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

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

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%

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

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

Minor Typo

I am submitting a -

Feature Request
Bug Report

guage --> gauge

Screenshots (if relevant) -

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.

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

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

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.

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) -

I am currently working on this.

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

Adding Subtractor (half and full) docs

I am submitting docs on -

[] Half subtractor
[] Full subtractor

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

YES

Adding Flip Flop documentation to the circuit elements in documentation

As of now there is no documentation for different flip flops.

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

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 .

Documentation for TTY

I am submitting a -

[] Feature Request

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

Yes

Document the use of FlipFlops

Adding a video in "Get started", To show How to recover project

I am submitting a -

[] Feature Request

Describe your bug/feature -
-A short video under get started that will show people how to recover project

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

Yes

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

Adding docs for Subtractor

I am submitting docs for -

Half Subtractor
Full Subtractor

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

Yes

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

Contributor's Guide Needed in this repository.

@satu0king Can I add Contributor's Guide on How to Contribute to this Repository by sending a PR?

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

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

Documentation for Parallel Binary Adders

I am submitting a -

[] Feature Request

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

Documentation for Combinational Analysis Feature

I am submitting a -

[] Feature Request

I am adding documentation on how to use Combinational Analysis feature

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

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

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) -

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) -

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

Yes

Documentation needed for Shift Registers.

@satu0king Documentation needed for these Digital Circuits known as Shift Registers which includes describing four types of Shift Registers in a sequential manner.