From: Benjamin Auder <benjamin.a@mailoo.org>
Date: Thu, 5 Feb 2015 20:25:43 +0000 (+0100)
Subject: README.html
X-Git-Url: https://git.auder.net/doc/html/packages.html?a=commitdiff_plain;h=8f96880ca0db6385e15bd28b2b336e88568a5741;p=pkgdev.git

README.html
---

diff --git a/README b/README
deleted file mode 100644
index be4a6d0..0000000
--- a/README
+++ /dev/null
@@ -1,36 +0,0 @@
-|--------------
-| 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
diff --git a/README.html b/README.html
new file mode 100644
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>