diff --git a/README.md b/README.md index bf52efb..13b474b 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@ [![Build Status](https://github.com/dylan-asmar/TagPOMDPProblem.jl/actions/workflows/BuildStatus.yml/badge.svg)](https://github.com/dylan-asmar/TagPOMDPProblem.jl/actions/workflows/BuildStatus.yml) [![codecov](https://codecov.io/gh/dylan-asmar/TagPOMDPProblem.jl/branch/main/graph/badge.svg?token=UNYWMYUBDL)](https://codecov.io/gh/dylan-asmar/TagPOMDPProblem.jl) - + +[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://dylan-asmar.github.io/TagPOMDPProblem.jl/stable) [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://dylan-asmar.github.io/TagPOMDPProblem.jl/dev) @@ -15,10 +16,10 @@ The Tag [1] problem with the [POMDPs.jl](https://github.com/JuliaPOMDP/POMDPs.jl ![Tag Demo](./gifs/tag_SARSOP.gif) ## Installation - +Use `]` to get to the package manager to add the package. ```julia -using Pkg -Pkg.add(url="https://github.com/dylan-asmar/TagPOMDPProblem.jl.git") +julia> ] +pkg> add TagPOMDPProblem ``` diff --git a/docs/make.jl b/docs/make.jl index 8beda64..991cdb9 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -5,12 +5,15 @@ push!(LOAD_PATH, "../src/") using Documenter, TagPOMDPProblem makedocs( + sitename = "TagPOMDPProblem.jl", + authors="Dylan Asmar", modules = [TagPOMDPProblem], format = Documenter.HTML(), - sitename = "TagPOMDPProblem.jl", + ) deploydocs( - repo = "github.com/dylan-asmar/TagPOMDPProblem.jl.git" + repo = "github.com/dylan-asmar/TagPOMDPProblem.jl.git", + devbranch = "dev", ) diff --git a/src/tag_types.jl b/src/tag_types.jl index c97dc3f..07e4a9b 100644 --- a/src/tag_types.jl +++ b/src/tag_types.jl @@ -15,7 +15,7 @@ struct TagState end """ - TagState + TagGrid Grid details for the Tag POMDP.