Update README.md Added formatting to highlight the importance of proper documentation
diff --git a/README.md b/README.md index b25eab7..3706438 100644 --- a/README.md +++ b/README.md
@@ -2,11 +2,10 @@ [](https://opensource.org/licenses/Apache-2.0) [](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml) ---- -**NOTE** +| :exclamation: Important Note | +|-----------------------------------------| -Fill this README with your caravel user project documentation. +## Please fill in your project documentation in this README.md file ---- Refer to [README](docs/source/index.rst) for this sample project documentation.