From 0c2a91d38a09766cd01f87716789e52a70291c3d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Marcus=20Thelander=20Andr=C3=A9n?=
<marcus.thelander_andren@control.lth.se>
Date: Sun, 11 Nov 2018 22:03:38 +0100
Subject: [PATCH] Update README.md
---
README.md | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 4b6ef85..134a0ec 100644
--- a/README.md
+++ b/README.md
@@ -19,19 +19,23 @@ The solution to this PDE is the relative value function $`V:\tilde{x}\rightarrow
For more details we refer to our [article](ecc2019_paper.pdf).
# Requirements
-The demo code has been tested for Julia version 0.6, which can be downloaded [here](https://julialang.org/downloads/oldreleases.html). The following packages are required:
+The demo code has been tested for Julia v0.6, which can be downloaded [here](https://julialang.org/downloads/oldreleases.html). The following packages are required:
- -OSQP
- -Roots
- -Plots
- -PyPlot
+* [OSQP](https://github.com/oxfordcontrol/OSQP.jl)
+* [Roots](https://github.com/JuliaMath/Roots.jl)
+* [Plots](http://docs.juliaplots.org/latest/)
+* [PyPlot](https://github.com/JuliaPy/PyPlot.jl)
-For each required package, simply run Pkg.add("package_name") in the Julia REPL to install it.
+For each required package, simply run `Pkg.add("package_name")` in the Julia REPL to install it.
# Running the Demo Code
-First make sure that you have installed Julia v0.6 and the required packages. Then start a Julia REPL in the directory where the file 'demo.jl' is located. In the Julia REPL, type 'include('demo.jl')' to run the demo.
+First make sure that you have installed Julia v0.6 and the required packages. Then start a Julia REPL in the directory where the file `demo.jl` is located. In the Julia REPL, type `include("demo.jl")` to run the demo.
-Note that it may take quite some time to run the demo the first time, since all the required packages are then being compiled.
+Note that it may take quite some time to run the demo the first time, since all the required packages are then being compiled. It takes roughly 1 min to run the entire script with $`30^2`=900$ collocation points.
+
+## Printouts
+
+## Plots
# Modifying the Demo Code
We encourage you to open the file 'demo.jl' and modify it to try out different precision of the approximation and different systems. Whenever you have changed the parameters to your liking, simply run 'include('demo.jl')' in the Julia REPL again to see the new result.
--
GitLab