Turning Readme into Markdown

Dockerfile

@@ -1,10 +0,0 @@
-# Dockerfile for binder
-# Reference: https://mybinder.readthedocs.io/en/latest/dockerfile.html#preparing-your-dockerfile
-
-FROM sagemath/sagemath:latest
-
-# Copy the contents of the repo in ${HOME}
-COPY --chown=sage:sage . ${HOME}
-
-# Install this package and dependencies
-RUN sage -pip install .

README.md

@@ -0,0 +1,46 @@
+# Vector Bundles
+
+This is a [SageMath](http://www.sagemath.org>) package implementing algorithms
+for creating and manipulating Vector Bundles over algebraic curves on finite
+field (some features should work on infinite field and most algorithms are 
+valid, but there is no guarantee for the implementation). All manipulations are 
+done using algebra on function fields.
+
+## Installation
+
+Download the source from the git repository:
+
+    $ git clone https://git.disroot.org/montessiel/vector-bundles-sagemath.git
+
+Change to the root directory and run:
+
+    $ sage -pip install --upgrade --no-index -v .
+
+For convenience this package contains a makefile with this
+and other often used commands. Should you wish too, you can use the 
+shorthand:
+
+    $ make install
+
+## Usage
+
+Once the package is installed, you can use it in Sage with:
+
+    sage: from vector_bundle import *
+
+See also the `demo notebook <demo.ipynb>`_ and the documentation.
+
+## Documentation
+
+The documentation of the package can be generated using Sage's
+``Sphinx`` installation::
+
+    $ cd docs
+    $ sage -sh -c "make html"
+
+You may also find an online version of the documentation [here](http://montessinos.fr/mickael/vector_bundle_doc/).
+
+## Warning
+
+This project is still young, and does not fully use the features of Sage. As
+these are integrated later on, they may come with breaking changes.

README.rst

@@ -1,64 +0,0 @@
-==============
-Vector Bundles
-==============
-
-This is a `SageMath <http://www.sagemath.org>`_ implementing algorithms for creating and
-manipulating Vector Bundles over algebraic curves on finite field. All manipulations are
-done using algebra on function fields.
-
-Installation
-------------
-
-Local install from source
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Download the source from the git repository::
-
-    $ git clone https://git.disroot.org/montessiel/vector-bundles-sagemath.git
-
-Change to the root directory and run::
-
-    $ sage -pip install --upgrade --no-index -v .
-
-For convenience this package contains a `makefile <makefile>`_ with this
-and other often used commands. Should you wish too, you can use the
-shorthand::
-
-    $ make install
-
-Usage
------
-
-
-Once the package is installed, you can use it in Sage with::
-
-    sage: from vector_bundle import *
-
-See also the `demo notebook <demo.ipynb>`_ and the documentation.
-
-Documentation
--------------
-
-The documentation of the package can be generated using Sage's
-``Sphinx`` installation::
-
-    $ cd docs
-    $ sage -sh -c "make html"
-
-Shorthand::
-
-    $ make doc
-
-TEST
-----
-
-To run the test suite of the package, simply run the command::
-
-    $make test
-
-from the root of the repository.
-
-CONTACT
--------
-
-Mickaël Montessinos: mickael.montessinos@mif.vu.lt