diff --git a/README.md b/README.md index e24d04dac052557f4c83c093045dd702e212659a..ec4f6b289a3a728303232e914e110437fc615e4b 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@ [](https://gitlab.inria.fr/solverstack/ScalFMM/commits/develop) ---- - +<!--- :warning: ScalFMM has moved to Inria's GitLab: https://gitlab.inria.fr/solverstack/ScalFMM ---- - +--> **ScalFMM** is a C++ library that implements a kernel independent Fast Multipole Method. @@ -51,7 +51,8 @@ You can do an out-of-source build by creating a `build` folder out of your clone folder inside your clone. ``` bash -cd scalfmm/Build +mkdir Build +cd Build # Use cmake, with relevant options cmake .. # -DSCALFMM_USE_MPI=ON ``` @@ -103,7 +104,8 @@ endif() The doc can be found [here](https://solverstack.gitlabpages.inria.fr/ScalFMM/) or you can build it locally. ```bash -cd scalfmm/Build + +cd Build cmake .. -DSCALFMM_BUILD_DOC=ON # or if cmake has already been called, ccmake . make doc ``` @@ -126,11 +128,11 @@ your feature in that branch. Keep your branch up to date by regularly rebasing y to date. Once your are done, send a merge request. ## Help and News - +soon available +<!--- You can subscribe to the scalfmm-public-users@lists.gforge.inria.fr mailing list (http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/scalfmm-public-users). The list is very low trafic (~ 2 mails per year), we will let you know of improvements and releases. -Contact the developers at : scalfmm-public-support@lists.gforge.inria.fr - +Contact the developers--> ## Folder structure - include : library core. - Data : particle distribution examples.