From 0ea5cec65d31c9b5c7c6b7dca1b824a6f2c29657 Mon Sep 17 00:00:00 2001
From: Uri Shaked <uri@urishaked.com>
Date: Sat, 23 Dec 2023 13:04:18 +0200
Subject: [PATCH] feat(docs): rename generated markdown index to
 shuttle_index.md

---
 docs/{README_init.md => shuttle_index_header.md} | 0
 documentation.py                                 | 8 ++++----
 shuttle.py                                       | 2 +-
 3 files changed, 5 insertions(+), 5 deletions(-)
 rename docs/{README_init.md => shuttle_index_header.md} (100%)

diff --git a/docs/README_init.md b/docs/shuttle_index_header.md
similarity index 100%
rename from docs/README_init.md
rename to docs/shuttle_index_header.md
diff --git a/documentation.py b/documentation.py
index 4599244..9a237cb 100644
--- a/documentation.py
+++ b/documentation.py
@@ -20,11 +20,11 @@ class Docs:
         self.script_dir = os.path.dirname(os.path.realpath(__file__))
 
     # stuff related to docs
-    def build_index(self):
-        logging.info("building doc index")
+    def build_index(self, filename="shuttle_index.md"):
+        logging.info(f"building {filename}")
         repo = git.Repo(".")
-        readme = self.load_doc_template("README_init.md")
-        with open("README.md", "w") as fh:
+        readme = self.load_doc_template("shuttle_index_header.md")
+        with open(filename, "w") as fh:
             fh.write(
                 readme.format(
                     name=self.config["name"],
diff --git a/shuttle.py b/shuttle.py
index db3dc26..7f6686a 100644
--- a/shuttle.py
+++ b/shuttle.py
@@ -211,7 +211,7 @@ class ShuttleConfig:
     def create_efabless_submission(self):
         logging.info("creating efabless submission directory:")
         lastrun = self.find_last_run("tt_top")
-        copy_print("README.md", "efabless/README.md")
+        copy_print("shuttle_index.md", "efabless/README.md")
         copy_print("shuttle_index.json", "efabless/shuttle_index.json")
         copy_print("verilog/rtl/user_defines.v", "efabless/verilog/rtl/user_defines.v")
         copy_print(