From c185849ae483b722b662ab75ce620367f3eec699 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Joachim=20Str=C3=B6mbergson?= <joachim@assured.se>
Date: Wed, 26 Apr 2023 13:58:48 +0200
Subject: [PATCH] Minor cleanup of README, testbench and Makefile
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Joachim Strömbergson <joachim@assured.se>
---
 hw/application_fpga/core/timer/README.md          | 12 ++++++++++--
 hw/application_fpga/core/timer/tb/tb_timer_core.v |  2 +-
 hw/application_fpga/core/timer/toolruns/Makefile  |  2 +-
 3 files changed, 12 insertions(+), 4 deletions(-)

diff --git a/hw/application_fpga/core/timer/README.md b/hw/application_fpga/core/timer/README.md
index ac2a3c3..9314d05 100644
--- a/hw/application_fpga/core/timer/README.md
+++ b/hw/application_fpga/core/timer/README.md
@@ -1,5 +1,13 @@
 # timer
-A simple timer with prescaler written in Verilog.
+A simple timer with prescaler.
 
 ## Introduction
-This core implements a simple timer with a prescaler. The purpose of the prescaler is to more easily time durations rather than cycles. If for example setting the timer to the clock frequency, the timer can cound seconds.
+This core implements a simple timer with a prescaler. The prescaler
+allows measurement of time durations rather than cycles. If for
+example setting the prescaler to the clock frequency in Hertz, the
+timer will count seconds.
+
+
+## Details
+The timer counter and the prescaler counter are both 32 bits.
+When enabled the counter counts down one integer value per cycle.
diff --git a/hw/application_fpga/core/timer/tb/tb_timer_core.v b/hw/application_fpga/core/timer/tb/tb_timer_core.v
index 35bcebc..5209fc9 100644
--- a/hw/application_fpga/core/timer/tb/tb_timer_core.v
+++ b/hw/application_fpga/core/timer/tb/tb_timer_core.v
@@ -222,7 +222,7 @@ module tb_timer_core();
   //----------------------------------------------------------------
   initial
     begin : timer_core_test
-      $display("--- Simulation of TIMER core started.");
+      $display("--- Simulation of timer core started.");
       $display("");
 
       init_sim();
diff --git a/hw/application_fpga/core/timer/toolruns/Makefile b/hw/application_fpga/core/timer/toolruns/Makefile
index f175458..9d3d443 100755
--- a/hw/application_fpga/core/timer/toolruns/Makefile
+++ b/hw/application_fpga/core/timer/toolruns/Makefile
@@ -57,7 +57,7 @@ clean:
 
 
 help:
-	@echo "Build system for simulation of Prince core"
+	@echo "Build system for simulation of timer core"
 	@echo ""
 	@echo "Supported targets:"
 	@echo "------------------"