X-Git-Url: https://git.auder.net/?p=pkgdev.git;a=blobdiff_plain;f=README.md;fp=README.md;h=b36c33df26f018ebf0306bd31b7e433dd255c83d;hp=0000000000000000000000000000000000000000;hb=bd56ff4e74044286d1d85a4065dc6739798ca721;hpb=27c6da509b81544a3fb32a55d8f7aeafe2ccfd54

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b36c33d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# pkgdev: help to develop R packages
+
+## Basic usage
+
+	#Install and load library
+	R CMD INSTALL path/to/pkgdev/folder
+	library(pkgdev) #inside R
+
+	#load some package (with its datasets)
+	pkgpath = "path/to/some/package"
+	pkgdev.load(pkgpath) #this command also reload package
+
+	#test it (if unit tests defined under tests/ subfolders)
+	pkgdev.rtest(pkgpath) ; pkgdev.ctest(pkgpath)
+
+	#you can also run its functions
+	foo(...) ; bar(...)
+
+	#...and so on
+
+	#finally, unload package
+	pkgdev.unload(pkgpath)</code></pre>
+
+Try also pkgTest/ testing package.