aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJosh Ott <joshott16@gmail.com>2022-05-16 23:50:43 -0400
committerJosh Ott <joshott16@gmail.com>2022-05-16 23:50:43 -0400
commitd673f11be621544e02501fd9f38718a40183590d (patch)
tree5241faa790d4df57f04f073511053d10213a2e8f /README.md
parent56fa8b8a06a317704d3199e3ed18ede01ed254c4 (diff)
downloadfourier-d673f11be621544e02501fd9f38718a40183590d.tar.gz
fourier-d673f11be621544e02501fd9f38718a40183590d.zip
Wrote README and added example
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 84d4b86..3541b3b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,11 @@
# fourier
-Fourier series animations from svg paths
+Fourier series animations from svg paths with Julia.
+
+When generating the svg files, the following must be true:
+* Relative positions are enforced (no upper case markers)
+* All segments of the path are bezier curves (no corners)
+* The path to draw must be the only path in the file
+
+This is easily accomplished in a program such as Inkscape.
+
+![Example gif](jerma.gif) \ No newline at end of file