Skip to content

Commit ef6a97b

Browse files
authored
Update README.md
1 parent 55bf6c1 commit ef6a97b

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,18 @@ For instructions on how to build HAL, please refer to the dedicated page in our
6060
# Quickstart Guide
6161

6262
Install HAL or build HAL and start the GUI via `hal -g`. You can list all available options via `hal [--help|-h]`.
63-
We included some example netlists in `examples` together with the implementation of the respective example gate library in `plugins/example_gate_library`.
63+
We included some example projects in `examples` subdirectory. To get startet with an example project you need to import
64+
it via `Import Project` from main menu or by dropping the zipped file in the `OPEN PROJECT` area of the Welcome Screen.
65+
Doing so a popup will request a directory with write permissions where HAL will create the project directory and uncompress
66+
the files. Do not use external tools for uncompress since adaptions are made so that netlist and gate library
67+
are found the next time the project gets opened.
68+
69+
In case you want to open your own Verlog or VHDL netlist you have to run `Import Netlist` instead. This will only work if
70+
there is a matching gate library in `plugins/gate_libraries/definitions` or you provide the gate library manually.
6471
For instructions to create your own gate library and other useful tutorials, take a look at the [wiki](https://github.com/emsec/hal/wiki).
6572

66-
Load a library from the `examples` directory and start exploring the graphical representation.
73+
The following example code refers to the `fsm` example.
74+
6775
Use the integrated Python shell or the Python script window to interact. Both feature (limited) autocomplete functionality.
6876

6977
Let's list all lookup tables and print their Boolean functions:

0 commit comments

Comments
 (0)