fix #2

README.Rmd

@@ -21,8 +21,6 @@ knitr::opts_chunk$set(
 [![R-CMD-check](https://github.com/b-rodrigues/rix/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/b-rodrigues/rix/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-**WARNING: This package is in very early development!**
-
 `{rix}` is an R package that provides functions to help you setup reproducible
 development environments that contain all the required packages that you need
 for your project. This is achieved by using the Nix package manager that you
@@ -163,3 +161,13 @@ You can install the development version of rix from [GitHub](https://github.com/
 # install.packages("devtools")
 devtools::install_github("b-rodrigues/rix")
 ```
+
+## Contributing
+
+This package is developed using the `{fusen}` package. If you want to
+contribute, please edit the `.Rmd` files found in the `dev/` folder. Then,
+inflate the package using `fusen::inflate_all()`. If no errors are found
+(warning and notes are ok), then commit and open a PR. To learn how to use
+`{fusen}` (don't worry, it's super easy), refer to this
+[vignette](https://thinkr-open.github.io/fusen/articles/How-to-use-fusen.html).
+

README.md

@@ -10,8 +10,6 @@
 [![R-CMD-check](https://github.com/b-rodrigues/rix/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/b-rodrigues/rix/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-**WARNING: This package is in very early development\!**
-
 `{rix}` is an R package that provides functions to help you setup
 reproducible development environments that contain all the required
 packages that you need for your project. This is achieved by using the
@@ -61,10 +59,14 @@ then use this environment to either work interactively, or run R
 scripts. It is possible to have as many environments as projects. Each
 environment is isolated (or not, it’s up to you).
 
-The main function of `{rix}` is called `rix()`. `rix()` has 4 arguments:
+The main function of `{rix}` is called `rix()`. `rix()` has several
+arguments:
 
   - the R version you need for your project
   - a list of R packages that your project needs
+  - an optional list of additional software (for example, a Python
+    interpreter, or Quarto)
+  - an optional list with packages to install from Github
   - whether you want to use RStudio as an IDE for your project (or VS
     Code, or another environment)
   - a path to save a file called `default.nix`.
@@ -75,7 +77,7 @@ For example:
 rix(r_ver = "current", pkgs = c("dplyr", "chronicler"), ide = "rstudio")
 ```
 
-The call above write a `default.nix` file in the current working
+The call above writes a `default.nix` file in the current working
 directory. This `default.nix` can in turn be used by Nix to build an
 environment containing RStudio, the current (or latest) version of R,
 and the latest versions of the `{dplyr}` and `{chronicler}` packages. In
@@ -138,6 +140,9 @@ by running:
 
     nix-shell /absolute/path/to/housing/default.nix --run Rscript -e 'targets::tar_make()'
 
+It’s possible to execute the pipeline automatically using a so-called
+“shell hook”. See the “How-to Nix” vignette for more details.
+
 ## Installation
 
 You can install the development version of rix from
@@ -147,3 +152,12 @@ You can install the development version of rix from
 # install.packages("devtools")
 devtools::install_github("b-rodrigues/rix")
 ```
+
+## Contributing
+
+This package is developed using the `{fusen}` package. If you want to
+contribute, please edit the `.Rmd` files found in the `dev/` folder.
+Then, inflate the package using `fusen::inflate_all()`. If no errors are
+found (warning and notes are ok), then commit and open a PR. To learn
+how to use `{fusen}` (don’t worry, it’s super easy), refer to this
+[vignette](https://thinkr-open.github.io/fusen/articles/How-to-use-fusen.html).