Skip to content

LogicalSimulator/LogicalSimulatorCommunity

Repository files navigation

LogicalSimulatorCommunity

Contribute with Gitpod License: LGPL-2.1 This repository's starred count

The community repository for Logical Simulator - the modern and intuitive digital logic gate simulator.

Adding examples or community circuits

If you want to add an example or community circuit, you can file an issue for that. If you want to do it yourself, we have a small CLI helper that will create and update the neccessary files, allowing you to type or paste in the new content!

If yarn doesn't work, you may have to prefix the commands with npx.

Install

  1. yarn to install dependencies.
  2. yarn run compile to compile the TypeScript down to JavaScript.

Usage

Run yarn run logicalSimulatorCommunityCLI.

An example command to add a circuit:

$ yarn run logicalSimulatorCommunityCLI add eightBitMemoryCell -t example -n "Eight-bit memory cell" -a "UnsignedArduino" --githubProfileURL "https://github.com/UnsignedArduino" --originalPostURL "https://github.com/LogicalSimulator/LogicalSimulatorCommunity/issues/5"

It is recommended to specify the author's GitHub profile URL and the link to the original post, as it shows up in the examples or community circuits page.

After running the command, there will be additional instructions specifying which files to add which content.