diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..523fdcf --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# pfm + +The R package **pfm** provides some utilities for dealing with FOCUS pesticide fate modelling tools, +made available under the GNU public license. This means: + + This program is free software: you can redistribute it and/or modify it under + the terms of the GNU General Public License as published by the Free Software + Foundation, either version 3 of the License, or (at your option) any later + version. + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + details. + + You should have received a copy of the GNU General Public License along with + this program. If not, see <http://www.gnu.org/licenses/> + +## Installation + +You can install the package from [github](http://github.com/jranke/pfm), e.g. +using the `devtools` package. Using `quick = TRUE` skips docs, +multiple-architecture builds, demos, and vignettes, to make installation as +fast and painless as possible. + +```s +library(devtools) +install_github("jranke/pfm", subdir = "pkg", quick = TRUE) +``` |