Prepare for release

ropensci · Jun 7, 2017 · a06c634 · a06c634
1 parent 927c9f4
commit a06c634
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 4 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,15 +1,16 @@
 Package: cld3
 Type: Package
 Title: Google's Compact Language Detector 3
-Version: 0.9000
+Version: 1.0
 Authors@R: c(
     person("Jeroen", "Ooms", ,"jeroen@berkeley.edu", role = c("aut", "cre")),
     person("Google Inc", role = "cph", comment = "CLD3 C++ library")
   )
 Description: Google's Compact Language Detector 3 is a neural network model for language 
-    identification and the successor of CLD2 (available from) CRAN. This version is still
-    experimental and takes a novell approach to language detection with different properties
-    and outcomes. See <https://github.com/google/cld3#readme> for more information.
+    identification and the successor of 'cld2' (available from CRAN). The algorithm is still
+    experimental and takes a novel approach to language detection with different properties
+    and outcomes. It can be useful to combine this with the Bayesian classifier results 
+    from 'cld2'. See <https://github.com/google/cld3#readme> for more information.
 License: Apache License 2.0
 Encoding: UTF-8
 LazyData: true

diff --git a/README.md b/README.md
@@ -36,3 +36,38 @@ cld3> detect_language_mixed("This piece of text is in English. Този текс
 2       en   0.9999790     TRUE  0.4146341
 3      und   0.0000000    FALSE  0.0000000
 ```
+
+
+
+## Installation
+
+Binary packages for __OS-X__ or __Windows__ can be installed directly from CRAN:
+
+```r
+install.packages("protolite")
+```
+
+Installation from source on Linux or OSX requires Google's [Protocol Buffers](https://developers.google.com/protocol-buffers/) library. On __Debian or Ubuntu__ install [libprotobuf-dev](https://packages.debian.org/testing/libprotobuf-dev) and [protobuf-compiler](https://packages.debian.org/testing/protobuf-compiler):
+
+```
+sudo apt-get install -y libprotobuf-dev protobuf-compiler
+```
+
+On __Fedora__ we need [protobuf-devel](https://apps.fedoraproject.org/packages/protobuf-devel):
+
+```
+sudo yum install protobuf-devel
+````
+
+On __CentOS / RHEL__ we install [protobuf-devel](https://apps.fedoraproject.org/packages/protobuf-devel) via EPEL:
+
+```
+sudo yum install epel-release
+sudo yum install protobuf-devel
+```
+
+On __OS-X__ use [protobuf](https://github.com/Homebrew/homebrew-core/blob/master/Formula/protobuf.rb) from Homebrew:
+
+```
+brew install protobuf
+```