diff --git a/README.md b/README.md index b8612a01..4111e2d3 100644 --- a/README.md +++ b/README.md @@ -108,27 +108,16 @@ For a debug build: cmake -DCMAKE_BUILD_TYPE=DEBUG .. ``` -A [FoBiS](https://github.com/szaghi/FoBiS) configuration file (`bspline-fortran.fobis`) is also provided that can build the library and examples. Use the `mode` flag to indicate what to build. For example: - -* To build all the examples using gfortran: `FoBiS.py build -f bspline-fortran.fobis -mode tests-gnu` -* To build all the examples using ifort: `FoBiS.py build -f bspline-fortran.fobis -mode tests-intel` -* To build a static library using gfortran: `FoBiS.py build -f bspline-fortran.fobis -mode static-gnu` -* To build a static library using ifort: `FoBiS.py build -f bspline-fortran.fobis -mode static-intel` - -The full set of modes are: - -* `static-gnu` -* `static-gnu-debug` -* `static-intel` -* `static-intel-debug` -* `shared-gnu` -* `shared-gnu-debug` -* `shared-intel` -* `shared-intel-debug` -* `tests-gnu` -* `tests-gnu-debug` -* `tests-intel` -* `tests-intel-debug` +A [FoBiS](https://github.com/szaghi/FoBiS) configuration file (`bspline-fortran.fobis`) is also provided that can also build the library and examples. Use the `mode` flag to indicate what to build. For example: + + * To build all the examples using gfortran: `FoBiS.py build -f bspline-fortran.fobis -mode tests-gnu` + * To build all the examples using ifort: `FoBiS.py build -f bspline-fortran.fobis -mode tests-intel` + * To build a static library using gfortran: `FoBiS.py build -f bspline-fortran.fobis -mode static-gnu` + * To build a static library using ifort: `FoBiS.py build -f bspline-fortran.fobis -mode static-intel` + + The full set of modes are: `static-gnu`, `static-gnu-debug`, `static-intel`, `static-intel-debug`, `shared-gnu`, `shared-gnu-debug`, `shared-intel`, `shared-intel-debug`, `tests-gnu`, `tests-gnu-debug`, `tests-intel`, `tests-intel-debug` + + To generate the documentation using [ford](https://github.com/cmacmackin/ford), run: ```FoBis.py rule --execute makedoc -f bspline-fortran.fobis``` # Documentation