Skip to content

Commit

Permalink
Package published on CRAN. Adapted README and added CRAN badge.
Browse files Browse the repository at this point in the history
  • Loading branch information
tpilz committed Feb 22, 2021
1 parent ba2af6b commit 149de59
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CRAN-RELEASE
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
This package was submitted to CRAN on 2021-02-18.
Once it is accepted, delete this file and tag the release (commit ba2af6b).
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<!-- badges: start -->
[![R-CMD-check](https://github.com/tpilz/telemac/workflows/R-CMD-check/badge.svg)](https://github.com/tpilz/telemac/actions)
[![CRAN status](https://www.r-pkg.org/badges/version/telemac)](https://CRAN.R-project.org/package=telemac)
<!-- badges: end -->

# telemac
Expand All @@ -10,7 +11,13 @@ The `telemac` package provides an interface to the integrated suite of solvers f

## Installation

It is planned to submit the package to the CRAN repository. So far it is only available via github and the source code needs to be compiled by yourself. The most convenient way is to compile and install it in R via the `tidyverse` package:
The package is available on [CRAN](https://cran.r-project.org/package=telemac) and can be installed via

```r
install.packages("telemac")
```

To install the latest development version the most convenient way is to compile and install it in R via the `tidyverse` package:

```r
# install.packages("devtools")
Expand Down

0 comments on commit 149de59

Please sign in to comment.