README.html

[pkgdev.git] / README.html

diff --git a/README.html b/README.html
new file mode 100644 (file)
index 0000000..eebf8f8
--- /dev/null
+++ b/README.html
@@ -0,0 +1,24 @@
+<h1>pkgdev: help to develop R packages</h1>
+
+<h2>Basic usage</h2>
+
+<pre><code>   #Install and load library
+   R CMD INSTALL path/to/pkgdev/folder
+   library(pkgdev) #inside R
+
+   #load some package
+   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>
+
+<p>Try also pkgTest/ testing package.</p>