commit ecb8155cac3df9d147fc753fba18b63c92610e63
author manarabdelaty <manarabdelatty@aucegypt.edu> Mon Apr 19 12:17:57 2021 +0200
committer manarabdelaty <manarabdelatty@aucegypt.edu> Mon Apr 19 12:17:57 2021 +0200
tree b59e84526533e0490e13c1c5d8ec65a17589ed48
parent 61f8ec4bf139cc341b434b501344b87e74c84a72
parent 84e4f8ebd42493efd3f8bc58c46109fe099ee9fa

Merge branch 'main' of https://github.com/efabless/caravel_project_example into main

README.md

diff --git a/README.md b/README.md
index d597451..3f94439 100644
--- a/README.md
+++ b/README.md
@@ -19,13 +19,22 @@
 # Caravel User Project
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_example_ci.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_example_ci.yml)
 
+# Table of contents
+- [Overview](#overview)
+- [Caravel Integration](#caravel-integration)
+    - [Repo Integration](#repo-integration)
+    - [Verilog Integration](#verilog-integration)
+- [Running Full Chip Simulation](#running-full-chip-simulation)
+- [Hardening the User Project Macro using Openlane](#hardening-the-user-project-macro-using-openlane)
+- [Checklist for Open-MPW Submission](#checklist-for-open-mpw-submission)
+  
 # Overview
 
 This repo contains a sample user project that utilizes the [caravel](https://github.com/efabless/caravel.git) chip user space. The user project is a simple counter that showcases how to make use of [caravel's](https://github.com/efabless/caravel.git) user space utilities like IO pads, logic analyzer probes, and wishbone port. The repo also demonstrates the recommended structure for the open-mpw shuttle projects. 
 
 # Caravel Integration
 
-## Files Integration
+## Repo Integration
 
 Caravel files are kept separate from the user project by having caravel as submodule. The submodule commit should point to the latest of caravel master. The following files should have a symbolic link to [caravel's](https://github.com/efabless/caravel.git) corresponding files: 
 
@@ -66,7 +75,7 @@
 
 # Running Full Chip Simulation
 
-The verilog test-benches are under this [verilog/dv](verilog/dv). For more information on setting up the simulation environment and the available testbenches for this sample project, refer to [README] (verilog/dv/README.md).
+The verilog test-benches are under this [verilog/dv](verilog/dv). For more information on setting up the simulation environment and the available testbenches for this sample project, refer to [README](verilog/dv/README.md).
 
 # Hardening the User Project Macro using Openlane 
 
@@ -90,9 +99,9 @@
 ```bash
 export OPENLANE_TAG=v0.12
 cd openlane
-# Runs openlane to harder user_proj_example
+# Run openlane to harden user_proj_example
 make user_proj_example
-# Runs openlane to harder user_project_wrapper
+# Run openlane to harden user_project_wrapper
 make user_project_wrapper
 ```