diff --git a/README.md b/README.md index 18287b3..cd96604 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,25 @@ [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://niklasmueboe.github.io/StereoSSAM.jl/dev) [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle) [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) + +## Installation + +The package can be installed with the Julia package manager. +From the Julia REPL, type `]` to enter the `Pkg` REPL mode and run: + +``` +pkg> add StereoSSAM +``` + +Or, alternatively, via the `Pkg` API: + +```julia +using Pkg +Pkg.add("StereoSSAM") +``` + +## Documentation + +The documentation for StereoSSAM.jl is available [here](https://niklasmueboe.github.io/StereoSSAM.jl/stable). +It includes the [Reference API](https://niklasmueboe.github.io/StereoSSAM.jl/stable/api) +as well as an [example analysis](https://niklasmueboe.github.io/StereoSSAM.jl/stable/examples/ExampleAnalysis). diff --git a/docs/src/index.md b/docs/src/index.md index d310c85..b07e3fe 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -9,6 +9,22 @@ reference to python repo If you use `StereoSSAM.jl` for your research please consider citing TODO +## Installation + +The package can be installed with the Julia package manager. +From the Julia REPL, type `]` to enter the `Pkg` REPL mode and run: + +``` +pkg> add StereoSSAM +``` + +Or, alternatively, via the `Pkg` API: + +```julia +using Pkg +Pkg.add("StereoSSAM") +``` + ## Index ```@contents