Skip to content

Commit

Permalink
docs(README): Update
Browse files Browse the repository at this point in the history
  • Loading branch information
nokome committed Feb 2, 2021
1 parent c498226 commit 98b35c7
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
3 changes: 1 addition & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ all: lint test cover build docs

# Setup the local development environment
setup:
Rscript -e "install.packages('devtools')"
Rscript -e "devtools::install_github(c('jimhester/lintr', 'klutometis/roxygen', 'r-lib/bench', 'r-lib/covr', 'r-lib/testthat', 'r-lib/pkgdown'))"
Rscript -e "install.packages('devtools'); devtools::install_dev_deps()"

# Do linting
lint:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

#### R interpreter for Stencila executable documents

[![Build Status](https://travis-ci.org/stencila/rasta.svg?branch=master)](https://travis-ci.org/stencila/rasta)
[![Build Status](https://dev.azure.com/stencila/stencila/_apis/build/status/stencila.rasta?branchName=master)](https://dev.azure.com/stencila/stencila/_build/latest?definitionId=12&branchName=master)
[![Code coverage](https://codecov.io/gh/stencila/rasta/branch/master/graph/badge.svg)](https://codecov.io/gh/stencila/rasta)
[![CRAN](https://www.r-pkg.org/badges/version-last-release/rasta)](https://cran.r-project.org/web/packages/rasta/)
[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://stencila.github.io/rasta/)
Expand Down Expand Up @@ -48,9 +48,9 @@ Most development tasks can be run from R, using `make` shortcuts, or RStudio key

Task | `make` | R/RStudio |
------------------------------------------------------- |-----------------------|-----------------|
Install development dependencies | `make setup` |
Install development dependencies | `make setup` | `devtools::install_dev_deps()`
Run linting | `make lint` | `lintr::lint_package()`
Run R tests | `make test-r` | `devtools::test()` or `Ctrl+Shift+T`
Run R tests | `make test-r` | `devtools::test()` or `Ctrl+Shift+T`
Run C++ tests | `make test-cpp` |
Run all tests | `make test`
Run tests with coverage | `make cover` | `covr::package_coverage()`
Expand All @@ -66,11 +66,11 @@ Unit tests live in the `tests` folder. Most of the tests are written using the `

### Documentation

Documentation is written using `roxygen2` and the documentation site is generated by `pkgdown` into the [`docs`](docs) folder and published on Github pages.
Documentation is written using `roxygen2` and the documentation site is generated by `pkgdown` into the `docs` folder and published on GitHub pages at https://stencila.github.io/rasta/.

### Continuous integration

Tests are run on [Travis](https://travis-ci.org/stencila/rasta) and code coverage tracked at [Codecov](https://codecov.io/gh/stencila/rasta).
Tests are run on [Azure Pipelines](https://dev.azure.com/stencila/stencila/_build?definitionId=12) and code coverage tracked at [Codecov](https://codecov.io/gh/stencila/rasta).

## Notes

Expand Down

0 comments on commit 98b35c7

Please sign in to comment.