add note about renaming

funcspec · May 23, 2023 · 8b08d31 · 8b08d31
1 parent 0201fe6
commit 8b08d31
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git 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
@@ -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`
-Original file line number
+Diff line change
@@ Expand Up / @@ -26,4 +26,4 @@ cabal-dev @@
     cabal.sandbox.config
     dist
     dist-*
-    report.cabal
+    *.cabal