From acc4b4b48367c714d465a6d22d3063235caed1d7 Mon Sep 17 00:00:00 2001
From: Daniel Vedder <daniel.vedder@idiv.de>
Date: Wed, 15 Jan 2025 15:25:01 +0100
Subject: [PATCH] Updated README
---
CONTRIBUTORS.md | 1 -
README.md | 21 +++++++++++++++------
2 files changed, 15 insertions(+), 7 deletions(-)
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
index 70d6208..18d9c8f 100644
--- a/CONTRIBUTORS.md
+++ b/CONTRIBUTORS.md
@@ -13,7 +13,6 @@
- Marco Matthies
- Gabriel Díaz Iturry
-
### Code reviewers
- Ludmilla Figueiredo
diff --git a/README.md b/README.md
index 0f785a0..450691d 100644
--- a/README.md
+++ b/README.md
@@ -12,20 +12,29 @@ growth submodel, and individual-based models of multiple indicator species. Its
investigate how changes in farm operations (e.g. through changes in the European Common
Agricultural Policy) influence biodiversity.
-**The model is still in development. A first version will be available in summer 2024.**
+**The model is still in development. A first version will be available in spring 2025.**
## Usage
-*For the full documentation, or visit the [website](https://persefone-model.eu/documentation).
+*For the full documentation, visit the [website](https://persefone-model.eu/documentation), or read the manual in the `docs` folder.
To use Persefone.jl with a graphical user interface, see [here](https://git.idiv.de/persefone/persefone-desktop).*
### Installation
Install the latest version of the [Julia](https://julialang.org/downloads/) programming
language (1.10+). The recommended editors are [VSCode](https://www.julia-vscode.org/) or
-[Emacs](https://www.emacswiki.org/emacs/JuliaProgrammingLanguage).
-To install package dependencies, open a Julia REPL in the Persefone root folder and run
-`using Pkg; Pkg.activate("."); Pkg.instantiate()`.
+[Emacs](https://www.emacswiki.org/emacs/JuliaProgrammingLanguage). Clone this
+repository, then install package dependencies by opening a Julia REPL in the Persefone
+root folder and running `using Pkg; Pkg.activate("."); Pkg.instantiate()`.
+
+Alternatively, if you only want to use the package from within Julia (see below),
+you can install it directly in any Julia REPL:
+
+```julia
+using Pkg
+Pkg.add(url="https://git.idiv.de/persefone/persefone-model.git")
+using Persefone
+```
### Running from the command line
@@ -90,4 +99,4 @@ list of exported functions.
---
-© 2022-2024 the contributors (MIT license)
+© 2022-2025 the contributors (MIT license)
--
GitLab