From d3cc79d1634b6c5c8920973b72beb1d7304510e4 Mon Sep 17 00:00:00 2001
From: Stephan Hilb <stephan@ecshi.net>
Date: Tue, 21 Jan 2025 16:23:48 +0900
Subject: [PATCH] update readme

---
 README.md | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index e1442aa..773c539 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,21 @@
 # SemiSmoothNewton
 
-Research code to produce numerical results for [1].
+Research code to produce numerical results for [1, 2].
 Read and use at your own risk.
 
-[1] Martin Alkämper, Stephan Hilb and Andreas Langer. 'A primal-dual adaptive
-finite element method for scalar and vectorial total variation minimization'.
-In preparation. 2022
+## Getting started
+
+Adjust data paths and experiments in `run.jl`, install dependencies and run:
+```julia
+using Pkg; Pkg.instantiate()
+include("run.jl")
+```
+
+## References
+
+[1] Hilb S., Langer A, Alkämper M.: A primal-dual finite element method for
+scalar and vectorial total variation minimization. Journal of Scientific
+Computing 96, 24 (2023).
+https://doi.org/10.1007/s10915-023-02209-2
+[2] Hilb S., Langer A, Alkämper M.: A primal-dual adaptive finite element
+method for total variation minimization. (2024). \[Submitted\]
-- 
GitLab