Skip to content

Interactive Book

Jump to bottom
Satvik Ramaprasad edited this page Mar 22, 2019 · 15 revisions

One of the initiatives that we would like to undertake is to create an online interactive guide for digital logic design. This means that the user can try out the circuits right from within the book to give the user a more interactive experience.

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.

Note that docs.circuitverse.org is different and is the documentation of CircuitVerse elements and features and very little emphasis on Digital Logic Design.

Use our Template for the proposal.

Level 1 of the interactive book

  1. Should have a framework which allows an easy way to contribute to the book, ideally all content should be written directly in markdown and rendered automatically by GitHub pages or a similar service. We would prefer not to have a server for this. We ask students to explore alternatives and we are open to suggestions. The primary requirement is that other content contributors should be able to contribute with minimum knowledge of programming.
  2. Mechanism to support multiple languages - support i18n capability
  3. Concepts to be covered
    • Binary Numbers, gates
    • Combinational Logic - Kmaps, X and Z states, Timing Analysis
    • Sequential Logic - latches, flipflops, FSMs etc to be covered in depth.
    • Computational blocks - ALU, Shifters, Rotators etc

Level 2 of the interactive book

  1. Advanced Digital Logic Topics
  2. User features like bookmarks
  3. Questions, exercises etc

GSoC Plan and Proposal

The goal for GSoC is to cover as much content as possible. The GSoC project will be about 80% content and 20% setup of the framework. We hope to complete level 1 of the project as much as possible. We are not very concerned about level 2 features at the moment.

Some points to note

  1. The ideal candidate is one who has good English skills and a good grasp on basic digital electronics.
  2. It is recommended that candidates solve as many issues in this repository so that we can gauge their documentation skills.
  3. The candidate is also asked to research on possible tools which can be used to build the book or propose building a custom tool and details regarding the same.
  4. Pictures/Descriptions of how you vision the book to be.
  5. Books and resources you will refer to for writing content for the book.
Clone this wiki locally