From 6a4b3e721918a987d6177d7bc5ca8c909388b9a7 Mon Sep 17 00:00:00 2001 From: tangxifan Date: Fri, 13 Nov 2020 09:20:30 -0700 Subject: [PATCH] [Doc] Update README about fabric key and apply minor format --- ARCH/README.md | 5 +++++ README.md | 5 ++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/ARCH/README.md b/ARCH/README.md index 4d8c5f3..f14efef 100644 --- a/ARCH/README.md +++ b/ARCH/README.md @@ -2,10 +2,15 @@ This directory contains the FPGA architecture description files for OpenFPGA tool suites. All the FPGA architecture description are binded to the opensource skywater 130nm PDK +--- + * Keep this folder clean and organized as follows - **vpr\_arch**: FPGA architecture description for VPR - **openfpga_arch_template**: template FPGA architecture description for OpenFPGA. - **openfpga_arch**: adapted FPGA architecture description for OpenFPGA which are converted from the templates. + - **fabric\_key**: the fabric key files used to custom floorplanning in FPGA netlists. See details [**here**](https://openfpga.readthedocs.io/en/master/manual/arch_lang/fabric_key/) + +--- * Note: - Please **ONLY** place folders under this directory diff --git a/README.md b/README.md index 0d1671b..ef9738a 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,9 @@ FPGA tape-outs using the open-source Skywater 130nm PDK and OpenFPGA git clone https://github.com/LNIS-Projects/skywater-openfpga.git python3 SCRIPT/repo_setup.py --openfpga_root_path ${OPENFPGA_PROJECT_DIRECTORY} ``` +--- -* If you have openfpga repository cloned in the level of this project, you can simple call +* If you have openfpga repository cloned at the same level of this project, you can simple call ```bash python3 SCRIPT/repo_setup.py ``` @@ -31,6 +32,8 @@ Otherwise, you should provide full path for the --openfpga\root\_path Keep a README inside the folder about the ICC2 version and how-to-use. - **MSIM**: workspace of verification using Mentor ModelSim +--- + * Note: - Please **ONLY** place folders under this directory. README should be the **ONLY** file under this directory