Create README.md
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ac9ca26 --- /dev/null +++ b/README.md
@@ -0,0 +1,12 @@ +# Adaptive CORDIC-based 32-point DCT + +[](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) + +| :exclamation: Important Note | +|-----------------------------------------| + +## Please fill in your project documentation in this README.md file + +Refer to [README](docs/source/quickstart.rst) for a quick start of how to use caravel_user_project + +Refer to [README](docs/source/index.rst) for this sample project documentation.