Changed README to a Markdown document.

It explain now the installation process of the package.

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..1bc3afc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# **DD-finite functions in Sage**
+
+`dd_functions` is a Sage package free to get from the git repository http://git.risc.jku.at/gitweb/?p=ajpastor/diff_defined_functions.git/ hosted by RISC (Research Intitute for Symbolic Computation). This package was developed in the research funded by the Austrian Science Fund  (FWF): W1214-N15, project DK15.
+
+This package allows Sage users to use _naturally_ DD-finite functions on the computer. This README includes a guide to how to install the package.
+
+## **1. Installing the package**
+There are three different ways to obtain the package.
+
+#### **Public _git_ repository**
+The package can be obtained freely from the public _git_ repository from RISC (Research Institute for Symbolic Computation): click [here](http://git.risc.jku.at/gitweb/?p=ajpastor/diff_defined_functions.git) for the webpage view or [clone](git.risc.jku.at:pub/ajpastor/diff_defined_functions) the repository (git.risc.jku.at:pub/ajpastor/diff_defined_functions).
+
+* This method allow the user to get the <font color="green">very last version</font> of the code.
+* From time to time, this means the version <font color="red">is not stable</font>.
+
+#### **Zip download from Webpage**
+The last <font color="green">stable version</font> of the code is always available on my [personal webpage](https://www.dk-compmath.jku.at/people/antonio). Just download it and unpack it. To update the code, <font color="red">redownload the zip file and update the folder manually</font>.
+
+##### **How to actually use the package**
+Once the repository is cloned or the zip is unpacked, one can run Sage inside the folder or add it to the standars PATH for Sage for look for packages modifying the file `~/.sage/sage.init` and adding the following lines:
+
+`import sys, os;
+sys.path.append(os.path.expanduser("###");`
+    
+where `###` is the path to the local copy of the package.
+
+#### **PiPy installation (<font color="red">not available</font>)**
+As the package is implemented in Python 2.7, we can use the following pip command:
+
+`pip install dd_functions`
+
+Using this method will provide <font color="green">the last stable version</font> with an <font color="green">easy way to update</font>.
+
+## **2. Using the package**
+Now that the package is installed, we can start using it importing the appropriate package:
+
+`from ajpastor.dd_functions import *`
+
+Or start a Jupyter notebook session for Sage and launch the demo contained in `dd_functions_demo.ipynb`.
\ No newline at end of file

diff --git a/README.txt b/README.txt
deleted file mode 100644 (file)
index 58dfef3..0000000
--- a/README.txt
+++ /dev/null
@@ -1,61 +0,0 @@
-###############################################################################
-###############################################################################
-###
-### README (for dd_functions SAGE package)
-###
-###############################################################################
-###############################################################################
-
-dd_functions is a SAGE package free to get from the git repository
-http://git.risc.jku.at/gitweb/?p=ajpastor/diff_defined_functions.git/
-hosted by RISC (Research Intitute for Symbolic Computation).
-
-This package was developed in the research funded by the Austrian Science Fund 
-(FWF): W1214-N15, project DK15.
-
-###############################################################################
-
-In this repository several files can be found int root folder:
-
-    - Makefile: a Makefile used for easy distribution of this repository. We do 
-    NOT recommend to use it.
-    - SPKG.txt: general information file with the description of the project the
-    name and email address of the author, and the License under which this project
-    was developed.
-    - dependencies: a file for the installation of the package in other SAGE systems.
-    It contains no dependencies.
-    - package-version.txt: a file with the number of the current version distributed
-    in this repository.
-    - setup.py: the installation file for this package. WARNING: this file and
-    installation has not been tested.
-    - type: file containing the keyword for the type of SAGE pakage this is. Currently
-    it is "optional".
-    - README.txt: the present file.
-    
-These files are not intended to be currently used by the user of this package since
-the setup file has not been yet tested. Within this root folder, two main folders
-can be found:
-
-    - ajpastor: the main folder with the Python-compiled source code. This is the 
-    main folder the user should be concerned for. 
-    The user can add this file to the SAGE searching path (in the init.sage file
-    of their SAGE distribution), or run SAGE from the root folder of the repository.
-    
-    This would give direct access to the sode developed in this project with the 
-    following syntax:
-        sage: from ajpastor.dd_functions import *
-    If some particualr package want to be loaded, just use the usual python import
-    notation naming the package aftes the "ajpastor" initial folder.
-        EXAMPLE: sage: from ajpastor.operator.OreOperator import *;
-        
-    - releases: in this folder the current version and older releases for the coded 
-    are stored (in .zip format). This files are named in the following way:
-        diff_defined_functions__XX.zip
-    where "XX" is the number of the version of the project they contain.
-    Inside this folder another directory can be found. This zip files follows the 
-    same convention for naming as in the "releases" folder, but it add also the 
-    date and hour this version was commited to the repository.
-    
-###############################################################################
-    named "old". Inside this fodler one can find the same kind of .zip files
-    for all the intermidiate releases for the code.