Update README.md
diff --git a/SVIncCompil/README.md b/SVIncCompil/README.md index ab24042..be06801 100644 --- a/SVIncCompil/README.md +++ b/SVIncCompil/README.md
@@ -40,16 +40,16 @@ ### Build * Run 3rd party build script (Builds antlr4.7.2, python3.6, flatbuffer, ccache) -cd Surelog/SVIncCompil -./build3rdparty.sh + * cd Surelog/SVIncCompil + * ./build3rdparty.sh * Build Surelog Pick your choice: -* ./buildall.sh (Builds all targets, release, debug...) -* ./buildrelease.sh (Builds the release target) -* ./builddebug.sh (Builds the debug target) -* ./buildreleasepp.sh (Updates the preprrocessor grammar and build the release target) -* ./buildpp.sh (Updates the preprrocessor grammar and build all targets) + * ./buildall.sh (Builds all targets, release, debug...) + * ./buildrelease.sh (Builds the release target) + * ./builddebug.sh (Builds the debug target) + * ./buildreleasepp.sh (Updates the preprrocessor grammar and build the release target) + * ./buildpp.sh (Updates the preprrocessor grammar and build all targets) ### Run a test @@ -76,12 +76,12 @@ Copy an exisitng launcher in the Project Manager Launcher menu, adapt to the test The following regression script will run all tests: -cd Testcases -./regression.tcl +* cd Testcases +* ./regression.tcl Regression options: - regression.tcl help - regression.tcl tests=<testname> (Tests matching regular expression) +* regression.tcl help +* regression.tcl tests=<testname> (Tests matching regular expression) test=<testname> (Just that test) debug=<none, valgrind, ddd> build=<debug, advanced, release, notcmalloc, undertow> @@ -89,28 +89,26 @@ mt=<nbThreads>" large (large tests too) show_diff (Shows text diff) - regression.tcl update (Updates the diffs) +* regression.tcl update (Updates the diffs) ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ## RELEASES -./release.tcl Releases the following: +* ./release.tcl Releases the following: -./release.tcl -Created dist/surelog_release_notcmalloc.tar.gz -Created dist/surelog_release_tcmalloc.tar.gz -Created dist/surelog_debug_notcmalloc.tar.gz -Created dist/surelog_debug_tcmalloc.tar.gz +* ./release.tcl + * Created dist/surelog_release_notcmalloc.tar.gz + * Created dist/surelog_release_tcmalloc.tar.gz + * Created dist/surelog_debug_notcmalloc.tar.gz + * Created dist/surelog_debug_tcmalloc.tar.gz Run this script at least once to create symbolic links for the Python Listener ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ## PROFILING -1) - -env CPUPROFILE=./prof env LD_PRELOAD="/usr/lib/libprofiler.so" ../../dist/Debug/GNU-Linux/surelog <test> +1) env CPUPROFILE=./prof env LD_PRELOAD="/usr/lib/libprofiler.so" ../../dist/Debug/GNU-Linux/surelog <test> google-pprof --callgrind ../../dist/Debug/GNU-Linux/surelog prof >> call @@ -137,7 +135,7 @@ ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ ## Useful links: -IEEE Std 1800-2012 +http://ecee.colorado.edu/~mathys/ecen2350/IntelSoftware/pdf/IEEE_Std1800-2017_8299595.pdf https://google.github.io/flatbuffers/flatbuffers_guide_use_cpp.html https://www.csee.umbc.edu/portal/help/VHDL/verilog/command_line_plus_options.html