Skip to content

Commit

Permalink
Move README to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmalhotra committed Oct 27, 2018
1 parent 6f047a0 commit 5d1c371
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 22 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Expand Up @@ -20,7 +20,7 @@ matrix:
script:
- ./autogen.sh
- ./configure
- make -j
- make all-examples -j

notifications:
email: true
2 changes: 1 addition & 1 deletion AUTHORS
@@ -1,6 +1,6 @@
Current developers:

Dhairya Malhotra <dmalhotra@ices.utexas.edu>
Dhairya Malhotra <contact@dhairyamalhotra.com>
George Biros <gbiros@acm.org>

PvFMM has been developed and is maintained by Parallel Algorithms for Data
Expand Down
27 changes: 8 additions & 19 deletions README → README.md
@@ -1,12 +1,7 @@
# PVFMM [![Build Status](https://travis-ci.org/dmalhotra/pvfmm.svg?branch=develop)](https://travis-ci.org/dmalhotra/pvfmm)

PVFMM README File
*****************

PVFMM Version 1.0.0 is the latest release (January 2014)


WHAT IS PVFMM?
==============
### What is PVFMM?

PVFMM is a library for solving certain types of elliptic partial
differential equations.
Expand All @@ -18,27 +13,22 @@ WHAT IS PVFMM?
Kernel Independent Fast Multipole Method.


HOW TO GET PVFMM
================
### How to get PVFMM

For the latest stable release of PVFMM
<URL: padas.ices.utexas.edu/pvfmm.tgz>
For the latest stable release of PVFMM visit [pvfmm.org](http://pvfmm.org)

LICENSE
=======
### License

PVFMM is distributed under the LGPLv3 licence. See COPYING in
the top-level directory of the distribution.

INSTALLING PVFMM
================
### Installing PVFMM

To install PVFMM, follow the steps in the INSTALL file, which is
located in the top directory of the source distribution.


USING PVFMM
===========
### Using PVFMM

The file examples/Makefile can be used as a template makefile for any
project using the library. In general the MakeVariables file should
Expand All @@ -60,8 +50,7 @@ USING PVFMM
path for precomputed data.


Acknowledgment
==============
### Acknowledgment

This software has been developed as part of the work supported by,
* US National Institutes of Health/10042242
Expand Down
2 changes: 1 addition & 1 deletion configure.ac
@@ -1,5 +1,5 @@
AC_PREREQ([2.61])
AC_INIT([PvFMM],[1.0.0],[dmalhotra@ices.utexas.edu])
AC_INIT([PVFMM],[1.0.0],[contact@pvfmm.org])

AC_CONFIG_MACRO_DIR([m4])
AC_CONFIG_AUX_DIR([build-aux])
Expand Down

0 comments on commit 5d1c371

Please sign in to comment.