Skip to content

Commit

Permalink
Revised README to point mostly to bookdown book re installation & docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@kbroman
kbroman committed Feb 11, 2019
1 parent fbf0687 commit c6f2e5a
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,18 @@ using [RaspberryJuice](https://dev.bukkit.org/projects/raspberryjuice)
and either [Spigot](https://www.spigotmc.org/) or
[Minecraft:Pi](https://minecraft.net/en-us/edition/pi/).

The miner package provides a few simple functions to manipulate the Minecraft world from R. See
the [vignette](vignettes/miner.Rmd) for details on setting up a Minecraft server and using
this package.

The
intent of this package is to encourage new R users to learn R by writing scripts to do fun things
in Minecraft. (See the [extra_vignettes](extra_vignettes) folder for details.)
For example, with these functions you could:
The miner package provides a few simple functions to manipulate the
Minecraft world from R. The intent of this package is to encourage new
R users to learn R by writing scripts to do fun things in Minecraft.

See the online book, [R Programming with
Minecraft](https://ROpenSciLabs.github.io/miner_book/), for details on
setting up a Minecraft server and using this package, and for a
variety of detailed examples. The package also contains a short
[vignette](vignettes/miner.Rmd) on its basic use.

Here are a few of the things you can do with
[miner](https://github.com/ropenscilabs/miner):

### Write words on a hillside:

Expand Down

0 comments on commit c6f2e5a

Please sign in to comment.