added documentation

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+site/

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -0,0 +1,17 @@
+using Documenter
+using EcologyInformedML
+
+makedocs(
+ sitename = "EcologyInformedML",
+ format = Documenter.HTML(),
+ modules = [EcologyInformedML]
+)
+
+deploydocs(repo = "github.com/vboussange/EcologyInformedML.jl", devbranch="main")
+
+# Documenter can also automatically deploy documentation to gh-pages.
+# See "Hosting Documentation" and deploydocs() in the Documenter manual
+# for more information.
+#=deploydocs(
+ repo = "<repository url>"
+)=#

docs/src/index.md

@@ -0,0 +1,9 @@
+# EcologyInformedML.jl
+
+```@eval
+DocStringExtensions.README
+```
+
+```@autodocs
+Modules = [EcologyInformedML]
+```

readme.md

@@ -3,4 +3,16 @@
 [![Build status (Github Actions)](https://github.com/vboussange/EcologyInformedML.jl/workflows/CI/badge.svg)](https://github.com/vboussange/EcologyInformedML.jl/actions)
 [![codecov.io](http://codecov.io/github/vboussange/EcologyInformedML.jl/coverage.svg?branch=main)](http://codecov.io/github/vboussange/EcologyInformedML.jl?branch=main)
 
-Suite for inverse modeling in ecology, combining ML techniques and ecological models (dynamical ODEs).
+Suite for inverse modeling in ecology, combining ML techniques and mechanistic ecological models (dynamical ODEs).
+
+## Installation
+Open Julia and type the following
+```julia
+using Pkg
+Pkg.add("https://github.com/vboussange/EcologyInformedML.jl)
+```
+This will download the latest version from the git repo and download all dependencies.
+
+
+## Getting started
+See the documentation and the `test` folder for up-to-date examples.