JanusHDL 0.7.0 (preview) - linux-x86_64
==========================================

JanusHDL is an HDL simulator: it analyzes, elaborates and runs VHDL designs
and their testbenches - VHDL-1993, 2002, 2008 and 2019, with PSL - and
shows their waveforms. Verilog and SystemVerilog come next. The standard
packages (std, ieee) are built in.

JanusHDL is free of charge, for anyone and any use, commercial work
included, and you may share unchanged copies: see LICENSE.txt.


Getting started
---------------

1. Unpack anywhere: on Windows, unzip it (for example to C:\Tools);
   on Linux, tar -xzf the archive (for example into ~/tools).
2. Add its bin folder to your PATH, or run the programs from it directly:

     jhdl       the command line: analyze, elaborate and run
     jhdlw      the window: waveforms, design browser, code editor,
                projects, and why a signal has its value
     jhdl-lsp   a language server, for your own editor

3. Run a testbench:

     jhdl counter.vhd counter_tb.vhd --top counter_tb

   or from a file list, which names the files in analysis order and the
   library of each:

     # proj.f
     library mylib
     src/counter.vhd
     tb/counter_tb.vhd

     jhdl -f proj.f --top mylib.counter_tb --stop-time 10us --wave run.jhw

   Open the waveforms with  jhdlw run.jhw  (or double-click a .jhw file
   after associating it with jhdlw). Or do it all in the window:
   start jhdlw and choose Simulate -> Run simulation...

4. For a design you come back to, a project file (.jhdlproj) keeps the
   sources with their libraries and VHDL versions, the top, its generics
   and the options: File -> New project... in the window, or
   jhdl run my.jhdlproj on the command line.

5. UVVM, OSVVM and VUnit are not included: get them from their own
   projects and analyze their sources with your design, their files first,
   each in its own library.

6. Your existing scripts: the compat folders hold small programs named
   like the commands such scripts call. Put one of them first on your PATH
   instead of bin, and the scripts run on JanusHDL as they are.

jhdl --help lists every option. The manual, also as a PDF, and a quick
start: https://que.no/janushdl


Notes for this preview
----------------------

- Until 1.0, options, file formats and the window may still change between
  versions. Newer builds read the files older ones wrote, and say so when
  they cannot.
- Code the standard forbids is an error; --compat runs it, with a warning
  that names the section of the standard (the compat front ends use it).
- Native code is on by default; --jit off runs the interpreter alone.


Files
-----

  bin                        the programs
  compat                     front ends for existing scripts
  vhdl                       the sources of the built-in libraries, to read
  README.txt                 this file
  LICENSE.txt                the license
  THIRD_PARTY_LICENSES.txt   the licenses of the third-party components
                             JanusHDL contains
