Browse Source

added short informations about library and how to build it

pull/1/head
T. Meissner 10 years ago
parent
commit
bd20626e00
1 changed files with 29 additions and 7 deletions
  1. +29
    -7
      README.md

+ 29
- 7
README.md View File

@ -1,11 +1,33 @@
libvhdl
=======
# libvhdl
A library of reusable components for VHDL designs and testbenches
sim
---
##sim
(Non) synthesible components for testbenches
test
----
Unit test for each component
##### QueueP
Package with various implementations of queue types:
* `t_simple_queue` simple array based FIFO queue
* `t_list_queue` linked list FIFO queue using access types
##test
Unit tests for each component
##### QueueT
Units tests for components of QueueP package
## Dependencies
To run the tests, you have to install GHDL. You can get it from [http://sourceforge.net/projects/ghdl-updates/](http://sourceforge.net/projects/ghdl-updates/).
## Building
Type `make` and you should see the successfully running tests
```
$ make
ghdl -a --std=02 ../sim/QueueP.vhd QueueT.vhd
ghdl -e --std=02 QueueT
ghdl -r --std=02 QueueT
QueueT.vhd:52:5:@0ms:(report note): INFO: t_simple_queue test finished successfully
QueueT.vhd:87:5:@0ms:(report note): INFO: t_list_queue test finished successfully
```

Loading…
Cancel
Save