Skip to content

Commit b862948

Browse files
committed
Updated README with more information
1 parent b2a07b8 commit b862948

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,14 @@ under development.
3636
* (libhdf5-dev) HDF5 1.10.7
3737
* (clang++) Clang, Version: 14.0.0 OR (g++) v13.0.0 or greater
3838

39-
1. Build Olympia, highly optimized, optimzed with debug, or debug. If
40-
sparta was NOT installed in the standand locations, the user can
41-
specify the path to sparta by setting
42-
`-DSPARTA_SEARCH_DIR=/path/to/sparta/install/` to `cmake`
39+
1. Build Olympia in one of three modes (see below):
40+
* `release`: Highly optimized, no debug w/ LTO (if supported)
41+
* `fastdebug`: Optimized, no LTO, with debug information
42+
* `debug`: All optimizations are disabled
43+
44+
If sparta was NOT installed in the standand locations, the user can
45+
specify the path to sparta by setting
46+
`-DSPARTA_SEARCH_DIR=/path/to/sparta/install/` to `cmake`
4347

4448
```
4549
################################################################################
@@ -50,7 +54,7 @@ mkdir release; cd release
5054
5155
# Assumes sparta was installed on the local machine
5256
# If not, use -DSPARTA_SEARCH_DIR=/path/to/sparta/install
53-
cmake .. -DCMAKE_BUILD_TYPE=Release
57+
cmake .. -DCMAKE_BUILD_TYPE=release
5458
5559
# Just builds the simulator
5660
make olympia

0 commit comments

Comments
 (0)