Skip to content

Commit

Permalink
doc: remove un-needed dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
js2264 committed Oct 4, 2023
1 parent 24ff954 commit 5921237
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 21 deletions.
12 changes: 3 additions & 9 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
Package: BiocBook
Title: Write, containerize, publish and versionize Quarto books with Bioconductor
Title: Write, containerize, publish and version Quarto books with Bioconductor
Description:
A BiocBook can be created by authors (e.g. R developers, but also
scientists, teachers, communicators, ) who wish to 1) write (compile a
scientists, teachers, communicators, ...) who wish to 1) write (compile a
body of biological and/or bioinformatics knowledge), 2) containerize
(provide Docker images to reproduce the examples illustrated in the compendium),
3) publish (deploy an online book to disseminate the compendium), and 4)
versionize (automatically generate specific online book versions
version (automatically generate specific online book versions
and Docker images for specific Bioconductor releases).
Version: 0.99.8
Date: 2023-08-03
Expand Down Expand Up @@ -42,15 +42,9 @@ Imports:
quarto,
renv
Suggests:
BiocManager,
BiocVersion,
BiocStyle,
rcmdcheck,
BiocCheck,
sessioninfo,
knitr,
testthat (>= 3.0.0),
RefManageR,
rmarkdown
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Expand Down
10 changes: 0 additions & 10 deletions Dockerfile

This file was deleted.

15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,18 @@ A `BiocBook` can be created by authors (e.g. `R` developers, but also scientists
1. *Write*: compile a **body of biological and/or bioinformatics knowledge**;
2. *Containerize*: provide **Docker images** to reproduce the examples illustrated in the compendium;
3. *Publish*: deploy an **online book** to disseminate the compendium;
4. *Versionize*: **automatically** generate specific online book versions and Docker images for specific [Bioconductor releases](https://contributions.bioconductor.org/use-devel.html).
4. *Version*: **automatically** generate specific online book versions and Docker images for specific [Bioconductor releases](https://contributions.bioconductor.org/use-devel.html).

## Installation

To install the most recent version of `BiocBook`, you can use:
To install `BiocBook` from Bioconductor, proceed as follows:

```r
if (!require("BiocManager", quietly = TRUE)) install.packages("BiocManager")
BiocManager::install("BiocBook")
```

To install `BiocBook` development version, you can use:

```r
install.packages("devtools")
Expand Down Expand Up @@ -52,6 +59,10 @@ preview(bb)
publish(bb)
```

Please read `BiocBook` vignette: `vignette("BiocBook")`.

You can also check out the [`BiocBookDemo` book](https://js2264.github.io/BiocBookDemo/devel/) to know more about `BiocBook`.

## Acknowledgments

This works was inspired by and closely follows the strategy used in coordination
Expand Down

0 comments on commit 5921237

Please sign in to comment.