Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Commit 3650a6b

Browse files
committed
Updated README.md to point to google.github.io/detectorgraph/ and other minor bits
1 parent ea033db commit 3650a6b

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ It forces an intuitive (albeit unusual) programming paradigm that results in hig
1111
This is not an officially supported Google product.
1212

1313
Note that the cross-reference links in this page are only rendered in the Doxygen version of the documentation (see [Building](#building)).
14+
You can also navigate the web version of the documentation hosted at https://google.github.io/detectorgraph/.
1415

1516
## Getting Started
1617

@@ -100,18 +101,16 @@ A more powerful & flexible option is to implement your own container to hold the
100101
### Tests, Docs and Examples
101102

102103
The library is shipped with a bare-bones makefile that can be used to build & run all of the examples, unit tests, documentation and coverage report.
104+
- Dependencies:
105+
- Gcc and/or clang with c++11
106+
- gcov & lcov (optional - for building test_coverage)
107+
- doxygen (optional - for building docs)
108+
- Eigen3 (optional - for building examples/robotlocalization)
103109

104-
* Dependencies:
110+
- Building:
105111

106-
* Gcc and/or clang with c++11
107-
* gcov & lcov (optional)
108-
* doxygen (optional)
109-
* c++filt (optional)
110-
111-
* Building
112-
113-
```
114-
# At the root directory
112+
# Hello World
113+
~/detectorgraph$ make examples/helloworld
115114

116115
# Build/Run unit tests
117116
~/detectorgraph$ make unit-test/test_all
@@ -121,7 +120,6 @@ The library is shipped with a bare-bones makefile that can be used to build & ru
121120

122121
# Build/Run Coverage test. Results in /coverage
123122
~/detectorgraph$ make unit-test/test_coverage
124-
```
125123

126124
### For your project
127125

@@ -145,4 +143,4 @@ The DetectorGraph library had a little naming problem growing up. From birth it
145143

146144
## In-depth Docs & API Reference
147145

148-
For in depth documentation of the library, [start here](@ref core_introduction) - these are provided by the [auto-generated docs](#building).
146+
For in depth documentation of the library, [start here](@ref core_introduction) - these are provided by the [auto-generated docs](https://google.github.io/detectorgraph/).

0 commit comments

Comments
 (0)