aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 23 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..7dc7dae
--- /dev/null
+++ b/README
@@ -0,0 +1,23 @@
+NAME
+ libtellurian - Geodesy library
+
+SYNPOSIS
+ #include <libtellurian.h>
+
+ Link with -ltellurian -lm.
+
+DESCRIPTION
+ libtellurian provides a collection of geodesy functions
+ and constants.
+
+ libtellurian always uses meters as the length unit,
+ meters per square-second as the acceleration unit,
+ and degrees for the angle unit, except when the
+ function name uses the suffix "_radians", in which
+ case the function uses radians instead of degrees.
+ All functions that input or output angles have a
+ version that uses degress and a version that uses
+ radians. Unless otherwise specified, functions that
+ use degress convert the input and output to and from
+ radians and call the version of the function that
+ uses radians.