Skip to content

Commit

Permalink
Revised the build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
MintoDA1 authored and MintoDA1 committed Sep 11, 2023
1 parent 3079ee6 commit 10c6950
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,18 @@ Navigate to the topmost directory in your CTEM repository. It is best practice t
$ cmake -B build -S .
$ cmake --build build
```
The CTEM executable, called `CTEM`, should now be created in the ```bin/``` directory.

The [CMake Fortran template](https://github.com/SethMMorton/cmake_fortran_template) comes with a script that can be used to clean out any build artifacts and start from scratch:
If you wish to install CTEM into the system, execute the following command:

```
$ cmake -P distclean.cmake
$ cmake --install build
```

This will install the project into the directory specified by `CMAKE_INSTALL_PREFIX` (the default is `/usr/local`), provided you have
sufficient permissions.


The CTEM CMake configuration comes with several customization options:

| Option | CMake command |
Expand All @@ -30,19 +35,20 @@ The CTEM CMake configuration comes with several customization options:
| Install prefix | \-DCMAKE_INSTALL_PREFIX=["/path/to/install"\|**"/usr/local"**] |



To see a list of all possible options available to CMake:
```
$ cmake -B build -S . -LA
```
For instance, if you wish to compile the project with debugging symbols enabled, run:

The CTEM executable, called `CTEM`, should now be created in the ```bin/``` directory.
```
$ cmake -B build -S . -DCMAKE_BUILD_TYPE=Debug
```

If you wish to install CTEM into the system, execute the following command:


The [CMake Fortran template](https://github.com/SethMMorton/cmake_fortran_template) comes with a script that can be used to clean out any build artifacts and start from scratch:

```
$ cmake --install build
$ cmake -P distclean.cmake
```

This will install the project into the directory specified by `CMAKE_INSTALL_PREFIX` (the default is `/usr/local`), provided you have
sufficient permissions.

0 comments on commit 10c6950

Please sign in to comment.