Better README

purdue-aalp · Sep 11, 2024 · 91fe045 · 91fe045
1 parent c47a3c6
commit 91fe045
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 101 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,18 @@
-The code in this project was tested with verilator version 4.038 and sbt version 1.8 or mill version 0.10.12.
+
+# Documentation
+The Ray Tracer Datapath is documented in our arXiv article: [A
+Hardware Ray Tracer Datapath with Generalized
+Features](https://arxiv.org/abs/2409.06000) where the following are discussed:
+- Supported operations
+- IO specification
+- Configurable parameters
+- Dataflow of pipeline stages
+- Hardware assets
+- Design choices
+- Description of source files
 
 # Prerequisites
+The code in this project was tested with verilator version 4.038 and sbt version 1.8 or mill version 0.10.12.
 - verilator (for running the testbenches)
 - sbt (optional) (for building the project with SBT)
 

diff --git a/TEMPLATE.README.md b/TEMPLATE.README.md