Skip to content

Commit b64672d

Browse files
authored
Update README.md
1 parent 2514be3 commit b64672d

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
# DistributedFactorGraphs.jl
22

3-
[![Build Status](https://travis-ci.org/JuliaArchive/DistributedFactorGraphs.jl.svg?branch=master)](https://travis-ci.org/JuliaArchive/DistributedFactorGraphs.jl)
4-
[![Coverage Status](https://img.shields.io/coveralls/JuliaArchive/DistributedFactorGraphs.jl.svg)](https://coveralls.io/r/JuliaArchive/DistributedFactorGraphs.jl?branch=master)
3+
[![Build Status](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl.svg?branch=master)](https://travis-ci.org/JuliaRobotics/DistributedFactorGraphs.jl)
4+
[![Coverage Status](https://img.shields.io/coveralls/JuliaRobotics/DistributedFactorGraphs.jl.svg)](https://coveralls.io/r/JuliaRobotics/DistributedFactorGraphs.jl?branch=master)
5+
[![docs](https://img.shields.io/badge/docs-latest-blue.svg)](http://juliarobotics.github.io/DistributedFactorGraphs.jl/latest/)
56

6-
[![DistributedFactorGraphs](http://pkg.julialang.org/badges/DistributedFactorGraphs_0.6.svg)](http://pkg.julialang.org/?pkg=DistributedFactorGraphs&ver=0.6)
7-
[![DistributedFactorGraphs](http://pkg.julialang.org/badges/DistributedFactorGraphs_0.7.svg)](http://pkg.julialang.org/?pkg=DistributedFactorGraphs&ver=0.7)
7+
DistributedFactorGraphs.jl provides a flexible factor graph API for use in the [Caesar.jl](https://github.com/JuliaRobotics/Caesar.jl) ecosystem. The package supplies:
8+
* A standardized API for interacting with factor graphs
9+
* Implementations of the API for in-memory and database-driven operation
10+
* Visualization extensions to validate the underlying graph
811

912
**Note** this package is still under initial development, and will adopt parts of the functionality currently contained in [IncrementalInference.jl](http://www.github.com/JuliaRobotics/IncrementalInference.jl).
1013

11-
# Install
14+
# Documentation
15+
Please see the [documentation](http://juliarobotics.github.io/DistributedFactorGraphs.jl/latest/) and the [unit tests](https://github.com/JuliaRobotics/DistributedFactorGraphs.jl/tree/master/test) for examples on using DistributedFactorGraphs.jl.
16+
17+
# Installation
18+
DistributedFactorGraphs.jl has not been registered yet, and should be installed by cloning this repository:
1219

1320
```julia
1421
Pkg.clone("https://github.com/JuliaRobotics/DistributedFactorGraphs.jl.git")

0 commit comments

Comments
 (0)