Commit 0c7c4bfcf920cfc5d66b0a7054a53904c668ef8f

Simon McVittie 2021-11-30T23:15:03

docs: Don't let Doxygen expand HOME environment variable Otherwise, the API documentation will encode the home directory of the user or autobuilder that built SDL, instead of telling the user to use the literal string $(HOME) as intended. See also <https://github.com/doxygen/doxygen/issues/7073>. Signed-off-by: Simon McVittie <smcv@debian.org>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
diff --git a/docs/README-macos.md b/docs/README-macos.md
index 67c53e2..9d2c6a9 100644
--- a/docs/README-macos.md
+++ b/docs/README-macos.md
@@ -239,8 +239,8 @@ Some of you won't want to use the Stationary so I'll give some tips:
 * Remove "main.m" from your project
 * Remove "MainMenu.xib" from your project
 * Remove "AppDelegates.*" from your project
-* Add "$(HOME)/Library/Frameworks/SDL.framework/Headers" to include path
-* Add "$(HOME)/Library/Frameworks" to the frameworks search path
+* Add "\$(HOME)/Library/Frameworks/SDL.framework/Headers" to include path
+* Add "\$(HOME)/Library/Frameworks" to the frameworks search path
 * Add "-framework SDL -framework Foundation -framework AppKit" to "OTHER_LDFLAGS"
 * Add your files
 * Clean and build