X-Git-Url: https://git.auder.net/?p=talweg.git;a=blobdiff_plain;f=pkg%2Fman%2Ftalweg-package.Rd;h=b49c8bfa279c6da123ec9166ad5ec2d6dceeb05c;hp=c0a75154aa410f5fa82ae1e24f931083c4126979;hb=4e25de2cf40b946ac6e8c2abc824637a249941d1;hpb=d09b09b0c811305405caf871d467f1a5ab34770f

diff --git a/pkg/man/talweg-package.Rd b/pkg/man/talweg-package.Rd
index c0a7515..b49c8bf 100644
--- a/pkg/man/talweg-package.Rd
+++ b/pkg/man/talweg-package.Rd
@@ -11,20 +11,15 @@
 	\packageDescription{talweg}
 }
 
+%TODO: better details
 \details{
-	The package devtools should be useful in development stage, since we rely on testthat for
-	unit tests, and roxygen2 for documentation. knitr is used to generate the package vignette.
-	Concerning the other suggested packages:
-	\itemize{
-		\item{TODO...;}
-		\item{TODO...;}
-	}
-
-	The three main functions are located in R/main.R:
-	\itemize{
-		\item{TODO...;}
-		\item{TODO...;}
-	}
+  To start working with this package, use ?computeForecast
+
+  The package R6 is used to abstract data and forecast(er)s implementation from their usage.
+
+	The package devtools could be useful in development stage, since we rely on testthat for
+	unit tests and roxygen2 for documentation. rainbow package is used for some plots:
+  \code{plotFbox()} and \code{plotFilamentsBox()}.
 }
 
 \author{
@@ -36,7 +31,3 @@
 %\references{
 %	TODO: Literature or other references for background information
 %}
-
-%\examples{
-%	TODO: simple examples of the most important functions
-%}