updating examples and readme files with the package configuration

README.md

@@ -40,19 +40,23 @@ By the moment this development version should be installed in two steps, since i
 
 #### 1. Install Elemental
 -  To install this program, it is a prerequisite to [install Elemental](http://libelemental.org/documentation/dev/build.html) as a shared library
+-  Try to install in the default path "/usr/local" so the library can be built
 
-#### 2. Download and compile the R-Elemental
+#### 2. Install R-Elemental
 
-1. Clone this git repository
-   `git clone https://github.com/rocanale/R-Elemental.git`
-2. Edit the Makefile and add the corresponding paths to the built elemental library and to the R headers
-3. build the library
+We still don't have the package in CRAN, but you can try this development version doing the following **as super user**:
+
+```s
+install.packages("devtools")
+library(devtools)
+install_github('R-Elemental','rocanale')
+```
 
 ## Package Structure
 
-*  The C source files in this package contain the C R-callable functions
+*  The C source files in this package (src folder) contain the C R-callable functions
 
-*  The file functionsObj.R loads the library and initializes the R functions
+*  The file RElem.R in the R/ folder, defines all the R functions
 
 ## Programming Approach
 
@@ -99,9 +103,9 @@ Note: it is always necessary to preload the openmpi library (or the one installe
 
 This example shows how to run a Gemm with distributed matrices
 
-```
+```s
 # Load the library
-source("functions.R")
+library(RElem)
 
 # Initialize Elemental/MPI
 Initialize()

SimpleDist.R

@@ -1,5 +1,5 @@
 # Load the library
-source("functions.R")
+library(RElem)
 
 # Initialize Elemental/MPI
 Initialize()

TODO.md

@@ -1,10 +1,11 @@
 #TODO
 
 * Define namespace for the Elemental functions loaded
-* Create a package structure and/or include it in elemental building system
-    * Create Makevars file, which explicitly links to elemental and the other libraries
+* Package Generation
+    * Edit Makevars file, so it can search in multiple paths
     * Document all the functions
+    * Add Examples
 * Restrict the functions, so they have datatype requirement specification
 * Add the functions for the other datatypes (integer, single, complex and double complex)
 * Add more MPI functions that can be useful
-* Try to generate more setup values for the functions i.e. orientation="NORMAL" and so on
+* Try to generate more default values for the functions i.e. orientation="NORMAL" and so on

man/RElem-package.Rd

@@ -0,0 +1,42 @@
+\name{RElem-package}
+\alias{RElem-package}
+\alias{RElem}
+\docType{package}
+\title{
+What the package does (short line)
+~~ package title ~~
+}
+\description{
+More about what it does (maybe more than one line)
+~~ A concise (1-5 lines) description of the package ~~
+}
+\details{
+\tabular{ll}{
+Package: \tab pRElem\cr
+Type: \tab Package\cr
+Version: \tab 1.0\cr
+Date: \tab 2014-10-22\cr
+License: \tab What license is it under?\cr
+}
+~~ An overview of how to use the package, including the most important ~~
+~~ functions ~~
+}
+\author{
+Who wrote it
+
+Maintainer: Who to complain to <yourfault@somewhere.net>
+~~ The author and/or maintainer of the package ~~
+}
+\references{
+~~ Literature or other references for background information ~~
+}
+~~ Optionally other standard keywords, one per line, from file KEYWORDS in ~~
+~~ the R documentation directory ~~
+\keyword{ package }
+\seealso{
+~~ Optional links to other man pages, e.g. ~~
+~~ \code{\link[<pkg>:<pkg>-package]{<pkg>}} ~~
+}
+\examples{
+
+}