From 4994d43883590afd68ce47332ca3fc5fc7caf28d Mon Sep 17 00:00:00 2001 From: Jan Eitzinger Date: Wed, 19 Aug 2020 10:04:34 +0200 Subject: [PATCH] Add documentation for options. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c03130..6c86ead 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,10 @@ Currently all settings are hard-coded in `main.c`. ## Run the benchmark -Just execute the binary. There are no options. +Without any options 200 steps with system size 32x32x32 is used. + +The default can be changed using the following options: +``` +-n / --nsteps : set number of timesteps for simulation +-nx/-ny/-nz : set linear dimension of systembox in x/y/z direction +```