Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroen committed Apr 1, 2019
1 parent e6c28d8 commit 6b9a98e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 16 deletions.
17 changes: 9 additions & 8 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Package: opencv
Type: Package
Title: Bindings to OpenCV
Title: Bindings to OpenCV Computer Vision Library
Version: 0.1
Authors@R: c(
person("Jeroen", "Ooms", role = c("aut", "cre"), email = "[email protected]",
comment = c(ORCID = "0000-0002-4035-0289")))
Description: Just messing around.
Authors@R: c(person("Jeroen", "Ooms", role = c("aut", "cre"),
email = "[email protected]", comment = c(ORCID = "0000-0002-4035-0289")))
Description: Experiment with computer vision and machine learning in R. This initial
version exposes some of the available OpenCV filters and algorithms (including
face detection), which can be applied to either static images or live webcam input.
License: MIT + file LICENSE
SystemRequirements: OpenCV
URL: https://github.com/ropenscilabs/opencv
BugReports: URL: https://github.com/ropenscilabs/opencv/issues
SystemRequirements: OpenCV: libopencv-dev (Debian, Ubuntu) or opencv-devel (Fedora)
URL: https://github.com/ropensci/opencv
BugReports: URL: https://github.com/ropensci/opencv/issues
LinkingTo: Rcpp
Imports: Rcpp, magrittr
LazyData: true
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2018
YEAR: 2019
COPYRIGHT HOLDER: Jeroen Ooms
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,9 @@

> Some experiments combining vision and graphics.
[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
[![Build Status](https://travis-ci.org/ropenscilabs/opencv.svg?branch=master)](https://travis-ci.org/ropenscilabs/opencv)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/ropenscilabs/opencv?branch=master&svg=true)](https://ci.appveyor.com/project/jeroen/opencv)
[![Build Status](https://travis-ci.org/ropensci/opencv.svg?branch=master)](https://travis-ci.org/ropensci/opencv)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/ropensci/opencv?branch=master&svg=true)](https://ci.appveyor.com/project/jeroen/opencv)

__NOTE:__ *this package is still very experimental. It may crash R.*

## Installation

Expand All @@ -16,15 +14,19 @@ On MacOS or Linux, first install opencv (not needed on Windows):
brew install opencv
```

On Ubuntu or Fedora you need [`libopencv-dev`](https://packages.debian.org/testing/libopencv-dev) or [`opencv-devel`](https://apps.fedoraproject.org/packages/opencv-devel/):

```sh
sudo apt-get install libopencv-dev
```

And then install the R bindings:

```r
devtools::install_github("ropenscilabs/opencv")
devtools::install_github("ropensci/opencv")
library(opencv)
```

Works best in the terminal (rstudio doesn't like the popup window).

## Basic stuff:

Face recognition:
Expand Down

0 comments on commit 6b9a98e

Please sign in to comment.