tinstall examples with documentation, expand README - granular - granular dynam… | |
git clone git://src.adamsgaard.dk/granular | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit 800c223ad51fd028760c1a57e24c3f853924a2e9 | |
parent 52e67fa0fb24d02637d9a201c8ec4956bf6479b0 | |
Author: Anders Damsgaard <[email protected]> | |
Date: Thu, 6 May 2021 10:15:00 +0200 | |
install examples with documentation, expand README | |
Diffstat: | |
M Makefile | 4 +++- | |
M README.md | 33 +++++++++++++++++++++++++++--… | |
R examples/many-grain-collision.sh -… | 0 | |
R examples/two-grain-collision.sh ->… | 0 | |
4 files changed, 32 insertions(+), 5 deletions(-) | |
--- | |
diff --git a/Makefile b/Makefile | |
t@@ -47,7 +47,9 @@ MAN1 = ${BIN:=.1}\ | |
MAN5 = ${NAME:=.5} | |
DOC = \ | |
README.md\ | |
- LICENSE | |
+ LICENSE\ | |
+ two-grain-collision.sh\ | |
+ many-grain-collision.sh | |
all: ${BIN} | |
diff --git a/README.md b/README.md | |
t@@ -1,18 +1,43 @@ | |
# granular | |
-Simulate granular mechanics with minimal external dependencies, respecting | |
-unix principles. | |
+Simulate granular mechanics with realistic physics and minimal | |
+external dependencies. | |
+ | |
## Building and installing | |
To build a fast version for performance, compile with the following | |
command: | |
- $ make CFLAGS="-O3" | |
+ $ make CFLAGS="-O3" | |
To build with debug symbols for development, compile with the command: | |
- $ make CFLAGS="-Wall -Wextra -pedantic -g" | |
+ $ make CFLAGS="-Wall -Wextra -pedantic -g" | |
+ | |
+ | |
+## Usage | |
+ | |
+This software consists of a series of programs each serving individual | |
+purposes. The user combines these programs in a way suitable for | |
+their needs. | |
+ | |
+The purpose, usage, and input/output formats of all programs are | |
+documented in their respective man pages, available after `make | |
+install`: | |
+ | |
+ man 5 granular # documentation on the general granular format | |
+ man granular # simulate interaction over time | |
+ man granular2img # conversion of the granular format to images | |
+ man granular2vtu # conversion of the granular format to VTK format | |
+ man granularenergy # calculate kinetic and potential energy | |
+ man granulargrain # program for creating a single grain | |
+ man granularpacking # create an assemblage of grains | |
+ | |
+There are usage examples (*.sh) which are by default installed to | |
+/usr/local/share/doc/granular/. | |
+ | |
## Author | |
+ | |
Anders Damsgaard https://adamsgaard.dk | |
diff --git a/examples/many-grain-collision.sh b/many-grain-collision.sh | |
diff --git a/examples/two-grain-collision.sh b/two-grain-collision.sh |