TinyTapeout/tt-support-tools
1
0
Fork 0
mirror of https://github.com/TinyTapeout/tt-support-tools.git synced 2026-11-03 04:36:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): update README template

Browse Source 
1. Include current shuttle name (instead of hard coded "Tiny Tapeout 03p5")
2. Include the git repo URL / commit hash
This commit is contained in:
Uri Shaked
2023-10-17 10:00:30 +03:00
parent 300a179400
commit 1c969fe0f3
2 changed files with 13 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README_init.md
+3 -22
View File
@@ -1,25 +1,6 @@
[![tinytapeout](https://github.com/tinytapeout/tinytapeout-03/actions/workflows/gds.yaml/badge.svg)](https://github.com/tinytapeout/tinytapeout-03/actions/workflows/gds.yaml)
[![verification](https://github.com/tinytapeout/tinytapeout-03/actions/workflows/verification.yaml/badge.svg)](https://github.com/tinytapeout/tinytapeout-03/actions/workflows/verification.yaml)
[![tt_datasheet](https://github.com/tinytapeout/tinytapeout-03/actions/workflows/tt_datasheet.yaml/badge.svg)](https://github.com/tinytapeout/tinytapeout-03/actions/workflows/tt_datasheet.yaml)
[![gl_verification](https://github.com/TinyTapeout/tinytapeout-03/actions/workflows/gl_verification.yaml/badge.svg)](https://github.com/TinyTapeout/tinytapeout-03/actions/workflows/gl_verification.yaml)
[![formal](https://github.com/TinyTapeout/tinytapeout-03/actions/workflows/formal.yaml/badge.svg)](https://github.com/TinyTapeout/tinytapeout-03/actions/workflows/formal.yaml)
[![sta](https://github.com/TinyTapeout/tinytapeout-03/actions/workflows/sta.yaml/badge.svg)](https://github.com/TinyTapeout/tinytapeout-03/actions/workflows/sta.yaml)
# {name}
# TinyTapeout 03.5
This repository contains the GDS file for the [{name}](https://tinytapeout.com) project. It was generated from {git_repo}@{git_commit}.
* Visit https://tinytapeout.com for more information on the project and how to get involved.
* Read [INFO](INFO.md) for how the project is built and technical project notes.
* Read [Verification](VERIFICATION.md) for how we verify the project.
# Datasheet
[PDF Download](datasheet.pdf).
For the most recent automatic build, click the tt_datasheet badge above, then download the PDF artifact.
# GDS layout of all projects
![tiny tapeout](pics/tinytapeout_numbered.png)
# Project Index
## Project Index
documentation.py
+10 -4
View File
@@ -22,10 +22,16 @@ class Docs:
# stuff related to docs
def build_index(self):
logging.info("building doc index")
with open(os.path.join(self.script_dir, "docs", "README_init.md")) as fh:
readme = fh.read()
repo = git.Repo(".")
readme = self.load_doc_template("README_init.md")
with open("README.md", "w") as fh:
fh.write(readme)
fh.write(
readme.format(
name=self.config["name"],
git_repo=get_first_remote(repo),
git_commit=repo.head.commit.hexsha,
)
)
fh.write("| Address | Author | Title | Type | Git Repo |\n")
fh.write("| ------- | ------ | ------| -----| ---------|\n")
self.projects.sort(key=lambda x: x.mux_address)
@@ -51,7 +57,7 @@ class Docs:
fh.write(json.dumps(designs, indent=4))
logging.info(f"wrote json to {self.args.dump_json}")
def load_doc_template(self, name):
def load_doc_template(self, name: str) -> str:
root = os.path.join(self.script_dir, "docs")
doc_path = os.path.join(root, name)
image_root = os.path.relpath(os.path.dirname(doc_path), ".")