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
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
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.
New site from Git
or go to https://app.netlify.com/startGitHub
and authorise Netlify to view all your repositories or just the repository that you would like to publish
Deploy site
(you do not need to change any settings other than maybe branch
)(git checkout -b feature/feature_name)
(git commit -am 'Add feature')
(git push origin feature_name)
Getting started with using the CircuitVerse Simulator requires some basic knowledge of the following aspects/concepts:
Read the Code of Conduct of our CircuitVerse community regarding contributing in the Documentation.
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.