aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranklin Wei <me@fwei.tk>2019-03-07 19:54:14 -0500
committerFranklin Wei <me@fwei.tk>2019-03-07 19:54:14 -0500
commit7975d798bab79156c82d02a21158fc698b500a4a (patch)
treee21cdf2db75e8c6c052e69d24f44cc491776927d
parenta168c5f9d4beb1adf3451a0de8472f47e009515a (diff)
downloadfieldviz-7975d798bab79156c82d02a21158fc698b500a4a.zip
fieldviz-7975d798bab79156c82d02a21158fc698b500a4a.tar.gz
fieldviz-7975d798bab79156c82d02a21158fc698b500a4a.tar.bz2
fieldviz-7975d798bab79156c82d02a21158fc698b500a4a.tar.xz
Don't use angle brackets
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 6613545..317cb99 100644
--- a/README.md
+++ b/README.md
@@ -43,20 +43,20 @@ plot the electric/magnetic fields they produce with the "field" command.
1. Line segment
- line <a> <b>
+ line [a] [b]
Pretty self-explanatory.
2. Arc
- arc <center> <radius> <normal> angle
+ arc [center] [radius] [normal] angle
center, radius, and normal are all vectors. Normal should be
normalized, or bad things might happen. Angle is the extent in radians.
3. Solenoid
- solenoid <center> <radius> <normal> angle pitch
+ solenoid [center] [radius] [normal] angle pitch
The first four parameters have the same meaning as they do with
arcs. The pitch parameter controls the linear distance between
@@ -64,7 +64,7 @@ successive turns.
4. Toroid
- toroid <center> <radius> <maj_normal> min_radius maj_angle pitch
+ toroid [center] [radius] [maj_normal] min_radius maj_angle pitch
center and radius have the same meaning as before. See the diagram
below for the meanings of the rest.