X-Git-Url: https://git.auder.net/?p=pkgdev.git;a=blobdiff_plain;f=README;fp=README;h=be4a6d0dcac6e5ee4d0e7ea7439b92bd258e036b;hp=1333ed77b7e1ed056329cae96075dc558158ee69;hb=672594cf38591923d9735f532b29af0b6a69e5c9;hpb=156f8ca651789536f3c0efd2af6c97f8b8e9eb54

diff --git a/README b/README
index 1333ed7..be4a6d0 100644
--- a/README
+++ b/README
@@ -1 +1,36 @@
-TODO
+|--------------
+| Basic usage :
+|--------------
+
+#Install
+R CMD INSTALL path/to/pkgdev/folder
+
+#Launch R
+R
+
+#load library
+library(pkgdev)
+
+#load some package
+pkgpath = "path/to/some/package"
+pkgdev.load(pkgpath)
+
+#test it (if unit tests defined under tests/ subfolders)
+pkgdev.rtest(pkgpath)
+pkgdev.rtest(pkgpath)
+
+#you can also run its functions
+foo(...)
+bar(...)
+
+#reload package to test modifications
+pkgdev.load(pkgpath)
+
+#...and so on
+
+#finally, unload package
+pkgdev.unload(pkgpath)
+
+---------------------------------
+
+Try also pkgTest/ testing package