diff --git a/README.md b/README.md index 55279a0..485f917 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ txviewer ======== -A set of eclipse plugins to show transaction logs created by the SystemC Verification Library \ No newline at end of file +A set of eclipse plugins to show transaction logs created by the SystemC +Verification Library (SCV). For further description of the SCV please refer to +http://www.accellera.org/activities/committees/systemc-verification + +The plugins are structured as follows: +- com.itjw.txviewer.database + the interface defining the API to access the database +- com.itjw.txviewer.database.text + an implementation of the API to read the text files generated by the SCV + sc_tr_text database +- com.itjw.txviewer.graph + 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 + the feature combining the plugins above into a somhow usable form + +To build the plugins the Eclipse SDK or PDE use used. In both cases the Groovy +eclipse plugin (http://groovy.codehaus.org/Eclipse+Plugin or Market) has to be +installed. \ No newline at end of file