Merge branch 'dev'

Cargo.toml

@@ -1,7 +1,7 @@
 
 [package]
 name = "rim"
-version = "0.1.4"
+version = "0.1.5"
 edition = "2021"
 authors = ["Gábor Csárdi <[email protected]"]
 license = "MIT"
@@ -17,7 +17,6 @@ categories = ["command-line-utilities"]
 
 [dependencies]
 clap = "3.0.10"
-clap_complete = "3.0.4"
 futures = "0.3.17"
 futures-util = "0.3.14"
 lazy_static = "1.3.0"

Makefile

@@ -1,6 +1,6 @@
 
 VERSION=$(shell grep "^version" Cargo.toml | tr -cd '0-9.')
-SOURCES=$(wildcard src/*.rs)
+SOURCES=$(wildcard src/*.rs) $(wildcard src/*.in)
 
 all:
 	@echo "Call 'make win' or 'make macos'"
@@ -57,7 +57,11 @@ rim-unnotarized-%.pkg: build.stamp  distribution.xml.in
 		--version $(VERSION) \
 		--sign "Developer ID Installer: Gabor Csardi" $@
 
-build.stamp: target/release/rim target/x86_64-apple-darwin/release/rim
+README.md: README.Rmd $(SOURCES)
+	cargo build --release
+	R -q -e 'rmarkdown::render("README.Rmd")'
+
+build.stamp: target/release/rim target/x86_64-apple-darwin/release/rim README.md
 	rm -rf build-arm64 build-x86_64
 	# arm64
 	mkdir -p build-arm64/usr/local/bin

NEWS.md

@@ -1,4 +1,8 @@
 
+# rim 0.1.5
+
+* Experimental Windows version.
+
 # rim 0.1.4
 
 * `resolve` and `add` work again.

README.Rmd

@@ -0,0 +1,80 @@
+---
+output: github_document
+---
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  comment = "#>",
+  out.width = "100%"
+)
+```
+
+# The R Installation Manager
+
+Install, remove, configure R versions.
+
+## 🚀  Features
+
+* Works on macOS and Windows. Linux version is coming soon!
+* Install multiple R versions, select the default one, run multiple
+  versions at the same time using quick links. E.g. `R-4.1` starts
+  R 4.1.x.
+* Select R version to install using symbolic names: `devel`, `release`,
+  `oldrel` and more.
+* On M1 macs select between x86_64 and arm64 versions or R, or install both.
+* Makes sure that installed packages are kept separete from the R
+  installation.
+* Includes auto-complete for `zsh` and `bash`.
+* Installs Rtools on Windows.
+
+## ⬇️  Installation
+
+Download the latest release from https://github.com/gaborcsardi/rim/releases.
+
+### Auto-complete
+
+The macOS installer and also installs the `zsh` and `bash` completions.
+`zsh` completions work out of the box.
+For `bash` completions install the `bash-completion` package from Homebrew 
+and make sure it is loaded from your `.bashrc`. (You don't need to install
+`bash` from Homebrew, but you can if you like.)
+
+## ⚙️  Usage
+
+Use `rim add` to add a new R installation:
+
+```
+rim add release
+```
+
+Use `rim list` to list the currently installed R versions, and `rim default`
+to set the default one.
+
+Run `rim` to see all commands and examples:
+
+```{bash, eval = FALSE}
+rim
+```
+
+```{bash, echo = FALSE, error = TRUE}
+./target/release/rim
+```
+
+Run `rim <subcommand> --help` for information about a subcommand:
+
+```{bash, eval = FALSE}
+rim default --help
+```
+
+```{bash, echo = FALSE}
+./target/release/rim default --help
+```
+
+## 🤝&nbsp; Feedback
+
+Please open an issue in our issue tracker at
+https://github.com/gaborcsardi/rim/issues
+
+## 📘&nbsp; License
+
+MIT 2021-2022 © RStudio Pbc.