Skip to content

Commit 16ff419

Browse files
committed
README
1 parent c7ed803 commit 16ff419

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Please see the [documentation](http://juliarobotics.github.io/DistributedFactorG
1616

1717
# Installation
1818
DistributedFactorGraphs can be installed from Julia packages using:
19-
```
19+
```julia
2020
add DistributedFactorGraphs
2121
```
2222

@@ -27,23 +27,23 @@ DistributedFactorGraphs (DFG) currently supports two implementations:
2727

2828
The in-memory implementation is the default. The Neo4j driver can be enabled by importing Neo4j before DFG:
2929

30-
```
30+
```julia
3131
# To enable the Neo4j driver, import Neo4j.jl first
3232
using Neo4j
3333
using DistributedFactorGraphs
3434
```
3535

3636
Both drivers support the same functions, so choose which you want to use when creating your initial DFG. For example:
3737

38-
```
38+
```julia
3939
# In-memory DFG
4040
dfg = GraphsDFG{NoSolverParams}()
4141
addVariable!(dfg, DFGVariable(:a))
4242
addVariable!(dfg, DFGVariable(:b))
4343
addFactor!(dfg, [v1, v2], DFGFactor{Int, :Symbol}(:f1)) # Rather use a RoME-type factor here (e.g. Pose2Pose2) rather than an Int, this is just for demonstrative purposes.
4444
```
4545

46-
```
46+
```julia
4747
# Neo4j-based DFG
4848
dfg = CloudGraphsDFG{NoSolverParams}("localhost", 7474, "neo4j", "test",
4949
"testUser", "testRobot", "testSession",
@@ -61,12 +61,12 @@ Please see the documentation for more information on interacting with the factor
6161
The simplest way to set up a test database is with Docker.
6262

6363
To pull the Neo4j image:
64-
```
64+
```bash
6565
docker pull neo4j
6666
```
6767

6868
To run the image with user `neo4j` and password `test`:
6969

70-
```
70+
```bash
7171
docker run --publish=7474:7474 --publish=7687:7687 --env NEO4J_AUTH=neo4j/test neo4j
7272
```

0 commit comments

Comments
 (0)