Skip to content

Commit ef5c325

Browse files
Add CMake instructions & options to Doxygen; use custom CSS for Doxygen (#594)
1 parent 01a1378 commit ef5c325

File tree

4 files changed

+2303
-17
lines changed

4 files changed

+2303
-17
lines changed

README.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -77,26 +77,23 @@ Hartnett](mailto:[email protected])
7777

7878
## Building
7979

80-
Download the tarball from the release page and unpack it, and cd into
81-
the main directory of the library. Then run the following commands,
82-
substituting your directory locations for the CMAKE_INSTALL_PREFIX
83-
(where the NCEPLIBS-g2c library will be installed), and the
84-
CMAKE_PREFIX_PATH (where the build will look for dependencies):
85-
86-
<pre>
87-
mkdir build
88-
cd build
89-
cmake -DCMAKE_INSTALL_PREFIX=/usr/local/NCEPLIBS-g2c -DCMAKE_PREFIX_PATH=/usr/local/jasper-3.0.5 ..
90-
make
91-
make test
92-
make install
93-
</pre>
80+
```console
81+
git clone https://github.com/NOAA-EMC/NCEPLIBS-g2c
82+
cmake -S NCEPLIBS-g2c -B NCEPLIBS-g2c/build # -DCMAKE_PREFIX_PATH=/usr/local/jasper-3.0.5 -DCMAKE_INSTALL_PREFIX=/path/to/install/g2c <add'l CMake options>
83+
cmake --build NCEPLIBS-g2c/build --parallel 4
84+
ctest --test-dir NCEPLIBS-g2c/build --parallel 4 # <add'l CTest options>
85+
# Install to CMAKE_INSTALL_PREFIX (/usr/local by default):
86+
cmake --install NCEPLIBS-g2c/build
87+
```
88+
89+
See the [documentation](https://noaa-emc.github.io/NCEPLIBS-g2c/) for a list
90+
of CMake options.
9491

9592
The NCEPLIBS-g2c library supports the PNG and JPEG2000 methods of image compression
9693
algorithms within the GRIB2 standard.
9794

98-
By default the library uses Jasper for JPEG functionality, use the
99-
USE_OpenJPEG to use the OpenJPEG library instead.
95+
By default the library uses Jasper for JPEG functionality, use
96+
`-DUSE_OpenJPEG=ON` to use the OpenJPEG library instead.
10097

10198
## References
10299

docs/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1342,7 +1342,7 @@ HTML_STYLESHEET =
13421342
# documentation.
13431343
# This tag requires that the tag GENERATE_HTML is set to YES.
13441344

1345-
HTML_EXTRA_STYLESHEET =
1345+
HTML_EXTRA_STYLESHEET = @abs_top_srcdir@/docs/customdoxygen.css
13461346

13471347
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
13481348
# other source files which should be copied to the HTML output directory. Note

0 commit comments

Comments
 (0)