Developer Guide

This guide tells you everything you need to get started with developing for LogikSim.

How to get the source code

To download the source code of LogikSim you need a working Git installation. More information on how to setup git can be found here.

Then you can simply checkout the latest code with:

git clone https://github.com/LogikSim/LogikSim.git

How the code is laid out

The code is structured as follows:

• src - contains main modules - see module documentation on top of each file for details
  • algorithms - algorithms known from literature in their standard form
  • debug - debug scripts to evaluate different design decisions
  • helper - code to increase debuggability
  • notes - text documents about different design concepts
  • symbols - definition of pre-defined logic blocks
  • tests - executable test suite

How to set up the build system

Before you can run LogikSim you need to install all dependecies. Follow the instructions outlined here for Linux and Windows.

How to run LogikSim

Follow the instructions here to run LogikSim and the test suite.

How to contribute

For concrete ideas have a look at ideas to contribute or contact us directly.

Before making changes to LogikSim have a look at our design philosophy and contribution guidelines.