TheCloud/Digital
1
0
Fork 0
mirror of https://github.com/hneemann/Digital.git synced 2025-09-10 05:15:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

updated the readme

Browse Source
This commit is contained in:
hneemann 2018-04-02 11:13:56 +02:00
parent 04f7df9eaa
commit d750e4e911
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -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. - 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. - 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. - Contains a library with the most commonly used 74xx series integrated circuits.
- Fast-run mode to perform a simulation without updating the GUI. - Good performance: The example processor can be clocked at 120 kHz.
A simple processor can be clocked at 100kHz.
- Supports large circuits: The "Conway's Game of Life" example consists of about 2400 active components - Supports large circuits: The "Conway's Game of Life" example consists of about 2400 active components
and works just fine. and works just fine.
- Its possible to use custom components which are implemented in Java and packed in a jar file. - 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. 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 - Simple remote TCP interface which e.g. allows an [assembler IDE](https://github.com/hneemann/Assembler) to control
the simulator. 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) - 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!) 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 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 [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. 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 - SVG export of circuits, including a LaTeX/Inkscape compatible SVG version (see
[ctan](https://www.ctan.org/tex-archive/info/svg-inkscape)) [ctan](https://www.ctan.org/tex-archive/info/svg-inkscape))
- No legacy code. - No legacy code.
@ -49,9 +48,9 @@ These are the main features of Digital:
## Documentation ## ## 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. 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 ## ## Comments ##
@ -59,7 +58,7 @@ If you want to send a bug report or feature request please use the GitHub
[issue tracker](https://github.com/hneemann/Digital/issues/new). [issue tracker](https://github.com/hneemann/Digital/issues/new).
This helps me to improve Digital, so do not hesitate. This helps me to improve Digital, so do not hesitate.
You can also send a private message to [digital-simulator@web.de](mailto:digital-simulator@web.de). It's also possible to send a private message to [digital-simulator@web.de](mailto:digital-simulator@web.de).
## Motivation ## ## Motivation ##