From 23a62e93f6aa48cb578d3439fc4e6957d1e619a8 Mon Sep 17 00:00:00 2001 From: Daniel Vedder <daniel.vedder@idiv.de> Date: Wed, 11 Sep 2024 15:41:15 +0200 Subject: [PATCH] Updated README, bumped version to 0.2.2 --- Project.toml | 2 +- README.md | 23 ++++++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/Project.toml b/Project.toml index eedbd3e..53fb184 100644 --- a/Project.toml +++ b/Project.toml @@ -1,7 +1,7 @@ name = "PersefoneDesktop" uuid = "78b50b3d-c6fc-409a-aced-ad0772f04556" authors = ["Daniel Vedder <daniel.vedder@idiv.de>"] -version = "0.2.1" +version = "0.2.2" [deps] CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b" diff --git a/README.md b/README.md index f812ebb..6dfb1d8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,28 @@ This is the graphical user interface to the [Persefone model](http://persefone-m With it, you can watch a simulation run unfold and interactively explore how the model functions. -## Install & run +## Quick start + +*Follow these instructions if you simply want to try out the software as a user. +If you want to play around with the source code, see the next section.* + +1. Download the [Julia programming language](https://julialang.org/downloads/) and install it on + your computer. +2. Start Julia. This should launch a commandline interface/REPL. +3. Execute the following commands (copy-and-paste should work): + +```julia +using Pkg +Pkg.add(url="https://git.idiv.de/persefone/persefone-model.git") +Pkg.add(url="https://git.idiv.de/persefone/persefone-desktop.git") +using PersefoneDesktop +ENV["QSG_RENDER_LOOP"] = "basic" # only needed on Windows +launch() +``` + +## Running from the repo + +*Follow these instructions if you want to get to grips with the source code.* **To install:** Install [Julia](https://julialang.org/downloads/) and download/clone this repository. Open a Julia REPL in the downloaded folder and execute the following -- GitLab