From 007d4ff9abee70b3647e6999faa13d09efe464d5 Mon Sep 17 00:00:00 2001 From: James Melville Date: Sat, 13 Oct 2018 11:49:23 -0700 Subject: [PATCH] Mention potential Makevars build problem on Mac (#1). --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7919eeb..17e50490 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,20 @@ distance functions and so on. It also works with `lvish`. ## Installing -`uwot` makes use of C++ code which must be compiled. Windows users, first install [Rtools](https://cran.r-project.org/bin/windows/Rtools/) and ensure `C:\Rtools\bin` is on your path. +`uwot` makes use of C++ code which must be compiled. You may have to carry out +a few extra steps before being able to build this package: + +**Windows**: install +[Rtools](https://cran.r-project.org/bin/windows/Rtools/) and ensure +`C:\Rtools\bin` is on your path. + +**Mac OS X**: using a custom `~/.R/Makevars` +[may cause linking errors](https://github.com/jlmelville/uwot/issues/1). +This sort of thing is a potential problem on all platforms but seems to bite +Mac owners more. +[The R for Mac OS X FAQ](https://cran.r-project.org/bin/macosx/RMacOSX-FAQ.html#Installation-of-source-packages) +may be helpful here to work out what you can get away with. To be on the safe +side, I would advise building `uwot` without a custom `Makevars`. ```R install.packages("devtools")