Skip to content

Commit

Permalink
Mention potential Makevars build problem on Mac (jlmelville#1).
Browse files Browse the repository at this point in the history
  • Loading branch information
jlmelville committed Oct 13, 2018
1 parent 6f9ec0f commit 69085df
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down

0 comments on commit 69085df

Please sign in to comment.