From 1d2c4d16afb225d20b82df09c9fc6c6ed10c703d Mon Sep 17 00:00:00 2001 From: Archie Jaskowicz Date: Sat, 18 Nov 2023 21:57:47 +0000 Subject: [PATCH] docs: added more info to install-brew --- docpages/install/install-brew.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docpages/install/install-brew.md b/docpages/install/install-brew.md index 873c16239e..a00d6bfd1e 100644 --- a/docpages/install/install-brew.md +++ b/docpages/install/install-brew.md @@ -8,10 +8,26 @@ brew install libdpp brew link libdpp ``` +This command will install libdpp and setup links so it can be used correctly. + You will now be able to use D++ by including its library on the command line: ```bash -clang++ -std=c++17 -L/opt/homebrew/lib -I/opt/homebrew/include -ldpp mybot.cpp -o mybot +clang++ -std=c++17 -I/opt/homebrew/include -ldpp mybot.cpp -o mybot ``` +\note A crucial part of this command is `-I/opt/homebrew/include`. AppleClang should automatically have `/opt/homebrew/lib` added as a way to detect library (if it doesn't, you can do `-L/opt/homebrew/lib` with this command), however, AppleClang does not auto-detect includes from homebrew. This means, D++ needs you to link the includes folder. + \include{doc} install_prebuilt_footer.dox + +## Uninstalling & Unlinking + +To unlink and uninstall dpp, run +```bash +brew unlink libdpp +brew uninstall libdpp +``` + +Then, double check inside `/opt/homebrew/lib` and `/opt/homebrew/include` to make sure that libdpp does not exist. If it does, remove files/folders relating to libdpp. + +**Have fun!** \ No newline at end of file