Skip to content

Commit

Permalink
doc: small changes to main-page
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Papior <[email protected]>
  • Loading branch information
zerothi committed Apr 4, 2016
1 parent fb5e9b9 commit fabb34c
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 31 deletions.
5 changes: 4 additions & 1 deletion doc/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,7 @@ buds have been developed by the following list of people:
The basic concept of the reference counted mechanisms is inspired by
the FLIBS project by Arjen Markus as well as minor things from the PyF95 project.

The initial draft of this library was created by Alberto Garcia.
The initial draft of this library was created by Alberto Garcia during extensions of the DFT software [SIESTA][siesta].

[siesta]: http://departments.icmab.es/leem/siesta/

2 changes: 1 addition & 1 deletion doc/DEV.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ create a custom bud type is listed here:
~~~~~~~{.f90}
type BUD_TYPE_NAME_
<contained data>
#include "buds_common_type.inc"
#include "buds_common_type_.inc"
end type
~~~~~~~

Expand Down
29 changes: 0 additions & 29 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,35 +28,6 @@ when to delete because of unknown depedencies.
- @ref develNotes
- @ref develNew


- @subpage contrib
- @ref contribAcknow


## Generic interface {#budsGenericInterface}

The basic buds-library adds certain files which are useful for creating
custom reference counted types using a standard. buds may be installed
in the most basic format which _only_ adds the interfaces for creating
custom data types. buds may be used in this minimal form.


## The standard bud library {#budsStandardLibrary}

In addition to the generic interfaces buds implements a selection of
data-types which have been encountered in the development of a density
functional theory code, [SIESTA][siesta]. All data-types are relying on the
generic interfaces.

You are encouraged to scour the documentation to find possible compatible
reference counted data types that you may find useful.

## Contributing {#budsContributing}

We encourage contribution, be it data-type suggestions and/or pull-requests.

Please see [how to contribute](@ref Development).



[siesta]: http://departments.icmab.es/leem/siesta/ "SIESTA"

0 comments on commit fabb34c

Please sign in to comment.