From 11ad6961808d0aa9767efe836b9ff219a4505cd8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tam=C3=A1s=20Simon?= <tamas.simon@alphacruncher.com>
Date: Mon, 2 Dec 2024 13:44:55 +0000
Subject: [PATCH] Updated documentation

---
 README.md | 27 +++++++++++++++++++++------
 1 file changed, 21 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 5ffc455..cdd4de1 100644
--- a/README.md
+++ b/README.md
@@ -16,15 +16,30 @@ The package can be currently installed from the GitLab repository:
 pip install git+https://git.dynare.org/Dynare/dynare-python.git
 ```
 
-## Example
-
-For an example on how to use the package, see `test/test_dynare.py`.
-
-### Simple example
+### Quickstart
 
 ```python
 from dynare import dynare
 
 context = dynare("<path_to_model_file.mod>")
 print(context)
-```
\ No newline at end of file
+```
+
+## Example
+
+For an example on how to use the package, see `test/test_dynare.py`.
+
+## Configuration
+
+To reuse and existing Julia environment, set the `PYTHON_JULIAPKG_EXE=<exe>` and `PYTHON_JULIAPKG_PROJECT=<project>` environment variables as documented in [pyjuliapkg](https://github.com/JuliaPy/PyJuliaPkg?tab=readme-ov-file#configuration).
+
+### No X-Windows server
+
+Dynare will try to open windows on your machine when it's completed computing. If there is no display on your system, you probably want to set the following environment variables to avoid related
+error messages:
+
+```
+export QT_QPA_PLATFORM=offscreen
+export DESKTOP_SESSION=none
+```
+
-- 
GitLab