mirror of
https://github.com/JHUAPL/Terrasaur.git
synced 2026-01-06 19:43:53 -05:00
documentation updates
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -3,7 +3,7 @@
|
||||
/doc/_build
|
||||
/dist/
|
||||
/target/
|
||||
/3rd-party
|
||||
3rd-party
|
||||
.DS_Store
|
||||
doc/tools/shortDescriptions.rst
|
||||
doc/tools/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 <https://docs.microsoft.com/en-us/windows/wsl/>`__.
|
||||
We have not tried using the softare on Microsoft Windows, but users may try the Linux package with the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/>`__.
|
||||
|
||||
Source code and build instructions are available at `GitHub <https://github.com/JHUAPL/Terrasaur>`.
|
||||
|
||||
Install
|
||||
~~~~~~~
|
||||
@@ -37,15 +39,6 @@ Documentation and Examples
|
||||
|
||||
`This <tools/index.html>`__ 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
|
||||
~~~~~~~~
|
||||
|
||||
|
||||
@@ -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.
|
||||
Reference in New Issue
Block a user