Skip to content

Commit

Permalink
updated the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hneemann committed Apr 2, 2018
1 parent 04f7df9 commit d750e4e
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,23 @@ These are the main features of Digital:
- Simple testing of circuits: You can create test cases and execute them to verify your design.
- Many examples: From a transmission gate D-flip-flop to a complete (simple) MIPS-like single cycle CPU.
- Contains a library with the most commonly used 74xx series integrated circuits.
- Fast-run mode to perform a simulation without updating the GUI.
A simple processor can be clocked at 100kHz.
- Good performance: The example processor can be clocked at 120 kHz.
- Supports large circuits: The "Conway's Game of Life" example consists of about 2400 active components
and works just fine.
- Its possible to use custom components which are implemented in Java and packed in a jar file.
See this [example](https://github.com/hneemann/digitalCustomComponents) for details.
- Simple remote TCP interface which e.g. allows an [assembler IDE](https://github.com/hneemann/Assembler) to control
the simulator.
- Components can be described using VHDL. The open source VHDL simulator [ghdl](http://ghdl.free.fr/) is required to
simulate a VHDL defined component. The ghdl source code is also available at [GitHub](https://github.com/ghdl/ghdl).
- Export to VHDL: A circuit can be exported to VHDL. There is also support for the
[BASYS3 Board](https://reference.digilentinc.com/reference/programmable-logic/basys-3/start). See the documentation
for details. The examples folder contains a variant of the example CPU, which runs on a BASYS3 board.
- Direct export of JEDEC files which you can flash to a [GAL16v8](https://www.microchip.com/wwwproducts/en/ATF16V8C)
or a [GAL22v10](https://www.microchip.com/wwwproducts/en/ATF22V10C). These chips are somewhat outdated (introduced in 1985!)
but sufficient for beginners exercises, easy to understand and well documented. Also the
[ATF150x](https://www.microchip.com/design-centers/programmable-logic/spld-cpld/cpld-atf15xx-family) chips are
supported which offer up to 128 macro-cells and in system programming. See the documentation for details.
- Components can be described by VHDL. The open source VHDL simulator [ghdl](http://ghdl.free.fr/) is required to
simulate a VHDL defined component. The ghdl source code is also available at [GitHub](https://github.com/ghdl/ghdl).
- Export to VHDL: A circuit can be exported to VHDL. There is also support for the
[BASYS3 Board](https://reference.digilentinc.com/reference/programmable-logic/basys-3/start). See the documentation
for details. The examples folder contains a variant of the simple CPU, which runs on a BASYS3 board.
- SVG export of circuits, including a LaTeX/Inkscape compatible SVG version (see
[ctan](https://www.ctan.org/tex-archive/info/svg-inkscape))
- No legacy code.
Expand All @@ -49,17 +48,17 @@ These are the main features of Digital:

## Documentation ##

A [documentation](https://github.com/hneemann/Digital/releases/latest) is available in English and German.
The [documentation](https://github.com/hneemann/Digital/releases/latest) is available in English and German.
It is still very incomplete but it contains a chapter "First Steps" which explains the basic usage of Digital.
The documentation also contains a list of available keyboard shortcuts.
The documentation also contains a list of available 74xx chips and a list of available keyboard shortcuts.

## Comments ##

If you want to send a bug report or feature request please use the GitHub
[issue tracker](https://github.com/hneemann/Digital/issues/new).
This helps me to improve Digital, so do not hesitate.

You can also send a private message to [[email protected]](mailto:[email protected]).
It's also possible to send a private message to [[email protected]](mailto:[email protected]).

## Motivation ##

Expand Down

0 comments on commit d750e4e

Please sign in to comment.