Updated README

This commit is contained in:
Eyck Jentzsch 2015-01-06 17:25:48 +01:00
parent de28761ce0
commit 5d3da392e2
1 changed files with 13 additions and 9 deletions

View File

@ -1,7 +1,7 @@
SCViewer
========
SCViewer is composed of a set of eclipse plugins to show VCD and transaction streams
SCViewer is composed of a set of eclipse plugins to display VCD and transaction streams
created by the SystemC VCD trace implementation and the SystemC Verification Library (SCV).
For further description of the SCV please refer to
http://www.accellera.org/activities/committees/systemc-verification.
@ -9,15 +9,20 @@ http://www.accellera.org/activities/committees/systemc-verification.
The viewer is in early alpha stage and not yet ready for production use!
The plugins are structured as follows:
- com.itjw.txviewer.database
the interface defining the API to access the database
- com.itjw.txviewer.database.text
- com.minres.scviewer.database
the interface defining the API to access the database and the implementation for VCD
- com.minres.scviewer.database.text
an implementation of the API to read the text files generated by the SCV
sc_tr_text database
- com.itjw.txviewer.graph
- com.minres.scviewer.database.sqlite
an implementation of the API to read the files generated by implementation in the
sc_tr_sqlite project using a SQLite based database
- com.minres.scviewer.database.test
a some JUnit tests of the 3 back ends
- com.minres.scviewer.ui
the viewer it self to diplay the transactions and associated views like the
outline of the DB and the properties of the transaction
- com.itjw.txviewer.feature
- com.minres.scviewer.feature
the feature combining the plugins above into a somhow usable form
To build the plugins the Eclipse SDK or PDE can be used. In both cases the Groovy
@ -26,7 +31,6 @@ installed.
TODO
====
- refactor the graphical viewer
- add means for testing and tests
- refactor the graphical viewer (again)
- add more tests
- additional analysis means
- VCD reader