From f14cbe8a2f6124b6bca3a6b23b5e735b715458b7 Mon Sep 17 00:00:00 2001
From: David Mapstone <david@mapstone.me>
Date: Thu, 16 Mar 2023 12:26:36 +0000
Subject: [PATCH] SOC1-124: Fixed SoCSim find path and added readme
---
README.md | 14 +++++++++-----
flow/socsim | 2 +-
set_env.sh | 1 +
3 files changed, 11 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 047477f..669cc32 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,12 @@
-# Sample GitLab Project
+# SoCSim
-This sample project shows how a project in GitLab looks for demonstration purposes. It contains issues, merge requests and Markdown files in many branches,
-named and filled with lorem ipsum.
+SoCSim is a very basic simulation framework which allows for easy running of simulation scripts.
+Scripts can be located in the simulate/socsim directory of any repository or subrepository of a project.
-You can look around to get an idea how to structure your project and, when done, you can safely delete this project.
+By using the
+```
+$ socsim $simulation_script
+```
+command, you can easily run your simulation scripts. This is done by socsim looking over a searchpath of socsim directories in your design project.
-[Learn more about creating GitLab projects.](https://docs.gitlab.com/ee/gitlab-basics/create-project.html)
+These scripts can call any simulator or external simulation flow and should make simulation management easier.
diff --git a/flow/socsim b/flow/socsim
index 890bbc3..43e0ebd 100755
--- a/flow/socsim
+++ b/flow/socsim
@@ -18,7 +18,7 @@ fi
# $SOC_TOP_DIR"/flow/simulators/"$SIMULATOR"_sim.sh" $@
# Find a simulation script in the SoCSim environments of all subrepos
-simscript=$(find -E ${SOCSIM_PATH//:/\/} -name "${1}.sh")
+simscript=$(find ${SOCSIM_PATH//:/\ } -name "${1}.sh")
# Run Script if Found
$simscript $@
\ No newline at end of file
diff --git a/set_env.sh b/set_env.sh
index 62d4533..b85e7e7 100644
--- a/set_env.sh
+++ b/set_env.sh
@@ -49,6 +49,7 @@ else
# SoCSim Specific
# Source environment variables for all submodules
+ SOCSIM_PATH="$DESIGN_ROOT/simulate/socsim"
for d in $DESIGN_ROOT/* ; do
if [ -f "$d/.git" ]; then
if [ -d "$d/simulate/socsim" ]; then
--
GitLab