diff --git a/README.md b/README.md index 6907c8d5a..65eb3b0a5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,37 @@ bessel-derivatives ================== -boost bessel derivatives +-------------------------------------------------------- +General Information +-------------------------------------------------------- + +This is a partial Boost.Math area for: + +* Bessel function derivatives +* This work is being developed for Anton Bikineev's magister thesis research + +-------------------------------------------------------- +Project details +-------------------------------------------------------- + +This project adds several new files to the existing file structure +of Boost.Math. These new files contain the implementations of +Bessel function derivatives. + +Upon successful completion of this project, the candidate files +in this project may potentially be merged to and/or included +in Boost.Math. + +-------------------------------------------------------- +Using this project with Boost +-------------------------------------------------------- + +The files in this project can be used with an existing Boost trunk +or with a distribution of Boost. Do note, however, that at the time +this project is being written, the files require the trunk in order +to compile. + +The way to use these files with an existing Boost trunk or distro +is to include the base directory of this project in the "C++ way". +The added include path of this project should be placed *before* the +include path of the Boost trunk or distro.