You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 29, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-12Lines changed: 10 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ It forces an intuitive (albeit unusual) programming paradigm that results in hig
11
11
This is not an officially supported Google product.
12
12
13
13
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/.
14
15
15
16
## Getting Started
16
17
@@ -100,18 +101,16 @@ A more powerful & flexible option is to implement your own container to hold the
100
101
### Tests, Docs and Examples
101
102
102
103
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)
103
109
104
-
* Dependencies:
110
+
- Building:
105
111
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
115
114
116
115
# Build/Run unit tests
117
116
~/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
121
120
122
121
# Build/Run Coverage test. Results in /coverage
123
122
~/detectorgraph$ make unit-test/test_coverage
124
-
```
125
123
126
124
### For your project
127
125
@@ -145,4 +143,4 @@ The DetectorGraph library had a little naming problem growing up. From birth it
145
143
146
144
## In-depth Docs & API Reference
147
145
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