From 22e7bb04f0892bcc2f94e7dc59d499637ef60559 Mon Sep 17 00:00:00 2001 From: Eyck Jentzsch Date: Tue, 6 Nov 2018 12:07:23 +0100 Subject: [PATCH] Updated documentation --- README.md | 33 ++++++------------- .../e4/application/messages.properties | 2 +- 2 files changed, 11 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8400f58..0733877 100644 --- a/README.md +++ b/README.md @@ -8,30 +8,16 @@ http://www.accellera.org/activities/committees/systemc-verification. > If you encounter issue when running on Linux please try running as `SWT_GTK3=0 scviewer` as there exist issues wiht GTK3. -The viewer is in early alpha stage and not yet ready for production use! +The viewer has the following features +- support of VCD files (compressed and uncompressed) + - real numbers + - showing vectors and real numbers as analog (step-wise & continuous) + - various value representations of bit vectors +- support of SCV transaction recordings in various formats + - text log files (compressed and uncompressed) + - sqlite based + - visualization of transaction relations -The plugins are structured as follows: -- 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.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.minres.scviewer.feature - the feature combining the plugins above into a somhow usable form -- scv_tr_sqlite - a C++ project containing the SQLite based SCV database implementation and the scv4tlm - socket implementations. - A simple example (scv_tr_recording_example.cpp) for testig purposes of the database is - provided. - To build the plugins the Eclipse SDK or PDE can be used. In both cases the Groovy eclipse plugin (http://groovy.codehaus.org/Eclipse+Plugin or Market) has to be installed. @@ -42,3 +28,4 @@ TODO - move to feature based product to allow automatic updates - improve graphics - catch-up e3 plugin to functionality of e4 product +- add calculated traces diff --git a/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/messages.properties b/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/messages.properties index 97d2bfd..ae08425 100644 --- a/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/messages.properties +++ b/com.minres.scviewer.e4.application/src/com/minres/scviewer/e4/application/messages.properties @@ -1,5 +1,5 @@ AboutDialog_0=\nSCViewer - a SystemC waveform viewer\n\nVersion: 2.0\n -AboutDialog_1=\nCopyright (c) 2015, 2018 MINRES Technologies GmbH and others.\n\nAll rights reserved. MINRES and the MINRES logo are trademarks of MINRES Technologies GmbH, http://www.minres.com/. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html\n\nParts of the software are governed by the Apache License Version 2.0 available at http://www.apache.org/licenses/. These are namely org.apache.jdbm and org.sqlite JDBC driver\n\nSources code is hosted at GitHub: https://github.com/minres/SCViewer\n +AboutDialog_1=\nCopyright (c) 2015, 2018 MINRES Technologies GmbH and others.\n\nAll rights reserved. MINRES and the MINRES logo are trademarks of MINRES Technologies GmbH, http://www.minres.com/. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html\n\nParts of the software are governed by the Apache License Version 2.0 available at http://www.apache.org/licenses/. These are namely org.mapdb and org.sqlite JDBC driver\n\nSources code is hosted at https://git.minres.com/VP/SCViewer and the master branch is mirrored to GitHub: https://git.com/minres/SCViewer\n DesignBrowser_12=Append all after DesignBrowser_16=Insert all before DesignBrowser_2=Enter text to filter waveforms