From 8b08d311abe48e1df21b6c19b27663c443b19b13 Mon Sep 17 00:00:00 2001
From: Malvin Gattinger <malvin@w4eg.de>
Date: Tue, 23 May 2023 14:57:08 +0200
Subject: [PATCH] add note about renaming

---
 .gitignore | 2 +-
 README.md  | 7 ++++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 97ac012..ccb18cd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -26,4 +26,4 @@ cabal-dev
 cabal.sandbox.config
 dist
 dist-*
-report.cabal
+*.cabal
diff --git a/README.md b/README.md
index 7e3fa83..4edba6d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,8 @@
 # Report Example
 
-See report.pdf for documentation.
+See [report.pdf](report.pdf) for documentation.
+
+Note: To rename the project you need to replace all occurrences of "report" with your own library name in the following files:
+
+- `hie.yaml`
+- `package.yaml`