diff --git a/README.md b/README.md new file mode 100644 index 00000000..f082e852 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# buds + +Library for creating buds of reference counted Fortran +objects. +A reference counted object will reduce memory overhead +by ensuring that an object is deleted once no variable +is referencing the object. + +## Documentation + +The complete documentation of buds may be found [here](http://siesta-project.github.io/buds/). + +## Download + +To download the latest buds library please see the [release page](https://github.com/siesta-project/buds/releases). + +## Installation + +The installation instructions of buds may be found [here](http://siesta-project.github.io/buds/installInstructions.html). +