From c16126cb159743904125dcd28cbbae9e46c53dfc Mon Sep 17 00:00:00 2001
From: Victor <bvictor@ethz.ch>
Date: Thu, 23 Jun 2022 15:36:47 +0200
Subject: [PATCH] added documentation

---
 docs/.gitignore   |  2 ++
 docs/Project.toml |  2 ++
 docs/make.jl      | 17 +++++++++++++++++
 docs/src/index.md |  9 +++++++++
 readme.md         | 14 +++++++++++++-
 5 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 docs/.gitignore
 create mode 100644 docs/Project.toml
 create mode 100644 docs/make.jl
 create mode 100644 docs/src/index.md

diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..a303fff
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,2 @@
+build/
+site/
diff --git a/docs/Project.toml b/docs/Project.toml
new file mode 100644
index 0000000..dfa65cd
--- /dev/null
+++ b/docs/Project.toml
@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
diff --git a/docs/make.jl b/docs/make.jl
new file mode 100644
index 0000000..c109812
--- /dev/null
+++ b/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>"
+)=#
diff --git a/docs/src/index.md b/docs/src/index.md
new file mode 100644
index 0000000..02ea4e3
--- /dev/null
+++ b/docs/src/index.md
@@ -0,0 +1,9 @@
+# EcologyInformedML.jl
+
+```@eval
+DocStringExtensions.README
+```
+
+```@autodocs
+Modules = [EcologyInformedML]
+```
\ No newline at end of file
diff --git a/readme.md b/readme.md
index e2ba251..1b9431b 100644
--- a/readme.md
+++ b/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).
\ No newline at end of file
+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.
\ No newline at end of file