tUpdate README - simple_DEM - a simple 2D Discrete Element Method code for educ… | |
git clone git://src.adamsgaard.dk/simple_DEM | |
Log | |
Files | |
Refs | |
LICENSE | |
--- | |
commit 521380771722b4949102b3cbbde1032f57736bbc | |
parent 52a46f334107f907709c131987a2db26ba237f5a | |
Author: Anders Damsgaard <[email protected]> | |
Date: Sat, 7 Sep 2019 06:43:09 +0200 | |
Update README | |
Diffstat: | |
M Makefile | 1 + | |
M README.rst | 21 +++++++++++++-------- | |
D output/blank.txt | 0 | |
3 files changed, 14 insertions(+), 8 deletions(-) | |
--- | |
diff --git a/Makefile b/Makefile | |
t@@ -10,6 +10,7 @@ DEPS=header.h global_properties.h | |
$(BIN): $(OBJ) | |
$(CC) $^ -o $@ $(LDFLAGS) | |
+ mkdir -p output | |
%.o: %.c $(DEPS) | |
$(CC) -c -o $@ $< $(CFLAGS) | |
diff --git a/README.rst b/README.rst | |
t@@ -2,9 +2,11 @@ | |
simple_DEM | |
========== | |
-A basic CPU-based discrete element method algorithm, created for comparison ag… | |
+A basic CPU-based discrete element method algorithm, created for comparison | |
+against more sophisticated codes. | |
-Written by Anders Damsgaard Christensen, `<[email protected]>`_, and is maintained… | |
+Written by Anders Damsgaard and is maintained at | |
+https://src.adamsgaard.dk/simple_DEM | |
Requirements | |
------------ | |
t@@ -14,7 +16,7 @@ Requirements | |
Obtaining | |
--------- | |
-``git clone https://github.com/anders-dc/simple_DEM.git`` | |
+``git clone git://src.adamsgaard.dk/simple_DEM`` | |
Building | |
-------- | |
t@@ -22,14 +24,17 @@ Building | |
Running | |
------- | |
-Simply execute ``./simple_DEM`` in the root folder. Output is written to the `… | |
-All simulation parameters must be specified in ``global_properties.h`` before … | |
+Simply execute ``./simple_DEM`` in the root folder. Output is written to | |
+the ``output/`` folder. All simulation parameters must be specified in | |
+``global_properties.h`` before compiling. If any parameters are changed, | |
+run ``make`` in the root folder. | |
Visualization | |
------------- | |
-See `<https://youtu.be/HOKfgUy5e58>`_ for an example on how to visualize the | |
-grains in Paraview. | |
+See `<https://youtu.be/HOKfgUy5e58>`_ for an example on how to visualize | |
+the grains in Paraview. | |
License | |
------- | |
-The code is licenced under the GNU Public License V.3, see ``license.txt`` for… | |
+The code is licenced under the GNU Public License V.3, see ``LICENSE.txt`` | |
+for details. | |
diff --git a/output/blank.txt b/output/blank.txt |