Skip to content

Commit

Permalink
shorten install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mschubert committed Feb 5, 2025
1 parent 2c4153f commit 08fbc72
Showing 1 changed file with 3 additions and 24 deletions.
27 changes: 3 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ This package will allow you to send function calls as jobs on a computing
cluster with a minimal interface provided by the `Q` function:

```r
# install the package if you haven't done so yet
install.packages('clustermq')

# load the library and create a simple function
library(clustermq)
fx = function(x) x * 2
Expand All @@ -32,30 +35,6 @@ Browse the vignettes here:
* [Technical Documentation](https://mschubert.github.io/clustermq/articles/technicaldocs.html)
* [FAQ](https://mschubert.github.io/clustermq/articles/faq.html)

Installation
------------

Install the `clustermq` package in R from CRAN (including the bundled
[ZeroMQ](https://github.com/zeromq/libzmq) system library):

```r
install.packages('clustermq')
```

Alternatively you can use the `remotes` package to install directly from
Github. Note that this version needs `autoconf`/`automake` and `CMake` for
compilation:

```r
# install.packages('remotes')
remotes::install_github('mschubert/clustermq')
# remotes::install_github('mschubert/clustermq@develop') # dev version
```

> [!TIP]
> For installation problems, see the
> [FAQ](https://mschubert.github.io/clustermq/articles/faq.html)
Schedulers
----------

Expand Down

0 comments on commit 08fbc72

Please sign in to comment.