From 1ee86517cf7ee90f44d2406f62df69a7880e1942 Mon Sep 17 00:00:00 2001 From: Hari Nair Date: Sat, 26 Apr 2025 09:41:35 -0400 Subject: [PATCH] documentation updates --- .gitignore | 2 +- doc/index.rst | 15 ++++----------- support-libraries/README.md | 4 ++++ 3 files changed, 9 insertions(+), 12 deletions(-) diff --git a/.gitignore b/.gitignore index fbd1b53..5254266 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,7 @@ /doc/_build /dist/ /target/ -/3rd-party +3rd-party .DS_Store doc/tools/shortDescriptions.rst doc/tools/index.rst diff --git a/doc/index.rst b/doc/index.rst index 2a188d2..4a18e52 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -16,9 +16,11 @@ The Terrasaur package requires Java 21 or later. Some freely available versions Download ~~~~~~~~ -Packages for use on Mac OS X and Linux are available at ... +Binary packages for use on Mac OS X and Linux are available at ... -Windows users may use the Linux package with the `Windows Subsystem for Linux `__. +We have not tried using the softare on Microsoft Windows, but users may try the Linux package with the `Windows Subsystem for Linux `__. + +Source code and build instructions are available at `GitHub `. Install ~~~~~~~ @@ -37,15 +39,6 @@ Documentation and Examples `This `__ page shows the usage of each utility. -Examples for use are shown at ... - -Build from source -~~~~~~~~~~~~~~~~~ - -Source code is available at ... - -Third party libraries are available at ... - Contents ~~~~~~~~ diff --git a/support-libraries/README.md b/support-libraries/README.md index e4b6ebc..fa06f25 100644 --- a/support-libraries/README.md +++ b/support-libraries/README.md @@ -12,6 +12,7 @@ The Terrasaur code is available at [GitHub](https://github.com/JHUAPL/Terrasaur. You may need to install the following packages with your favorite package manager: * [Apache Ant](https://ant.apache.org/) - needed for OpenCV Java support +* [CMake](https://cmake.org/) - used to build VTK and OpenCV * [SQLite](https://www.sqlite.org/index.html) - needed for lidar-optimize ## Build the packages @@ -29,3 +30,6 @@ an intel macOS system): ./buildAll.bash ../3rd-party/$(uname -s)_$(uname -m) ``` +### Note for macOS users + +We have found that the VTK library will not compile with the XCode command line tools version 16.3 with clang-1700.0.13.3. We could successfully compile after downgrading to the Xcode 16 command line tools with clang-1600.026.3. \ No newline at end of file