From d7179baef9d82fedbf466f401eee6813d654e5ae Mon Sep 17 00:00:00 2001 From: Tudor Timi Date: Sat, 5 Mar 2022 09:20:16 -0800 Subject: [PATCH 1/3] Clarify that `gradle-hdvl` provides multiple plugins --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2d71911..2fc4aaa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,2 @@ # gradle-hdvl -Gradle plugin that provides support for hardware design and verification languages +Family of Gradle plugins that provide support for hardware design and verification languages From 2fe760d2ab752154e5f377aa9e283abd444bac0c Mon Sep 17 00:00:00 2001 From: Tudor Timi Date: Sat, 5 Mar 2022 09:25:23 -0800 Subject: [PATCH 2/3] Add "Features" section to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2fc4aaa..fe45f63 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # gradle-hdvl Family of Gradle plugins that provide support for hardware design and verification languages + + +## Features + +Generates simulator argument files to compile SystemVerilog and C. +These argument files can be integrated into an existing simulation setup. + +Currently supports Xcelium and QuestaSim. + +Also supports testing using SVUnit and generating DVT projects. From 1892f31d20a7468c81a720ab38f61c467e124395 Mon Sep 17 00:00:00 2001 From: Tudor Timi Date: Sat, 5 Mar 2022 09:30:18 -0800 Subject: [PATCH 3/3] Add "Notes" section to README --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index fe45f63..d30f9c0 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,12 @@ These argument files can be integrated into an existing simulation setup. Currently supports Xcelium and QuestaSim. Also supports testing using SVUnit and generating DVT projects. + + +## Notes + +The DSL is not yet stable and parts will most definitely change in the future. +The examples serve as de-facto documentation. + +The plugin API is also not yet stable, +so it's probably not a good idea to start writing extensions to it just yet.