From c848c430d08ad67d96be7bbb667eb4f2d4dbd6e9 Mon Sep 17 00:00:00 2001
From: Maik Herbers <maik.herbers@stud.tu-darmstadt.de>
Date: Thu, 16 Feb 2023 22:16:03 +0100
Subject: [PATCH] Add README.
* README: New file.
---
README | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 58 insertions(+)
create mode 100644 README
diff --git a/README b/README
new file mode 100644
index 0000000..c73bbbf
--- /dev/null
+++ b/README
@@ -0,0 +1,58 @@
+ __________
+
+ POLYPLOT
+ __________
+
+Dependencies
+============
+
+ Other versions may work but this hasn't been tested
+ - libpng (1.6.37)
+ - mpc (version 1.2.1)
+ - mpfr (version 4.1.0)
+
+ Using the [GNU Guix] package manager, you can simple run
+ ,----
+ | guix shell -f guix.scm
+ `----
+ to get a shell with everything set up. You can also authenticate the
+ git history with
+ ,----
+ | guix git authenticate -k origin/keyring \
+ | 1fb8ce84b2e4329007a23c047a8ea211d629da00 \
+ | 'D5BA 4708 FA7D 0AFD 9C0E 6556 ECD7 F82F 5327 404C'
+ `----
+ In order to get a (hopefully) identically environment, you can run
+ ,----
+ | guix time-machine --commit=716f2b330fb0566e48423a7f928759a351e73850 -- \
+ | shell -f guix.scm
+ `----
+
+
+[GNU Guix] <https://guix.gnu.org/>
+
+
+Usage
+=====
+
+ The coefficient file has to be a whitespace seperated list of
+ coefficients. They can be written as decimal numbers (e.g. `23.3'),
+ floating point numbers (e.g. `1.25e+7') or pairs of two such numbers
+ as real and imaginary part respectivel (e.g. `(3 1.3e-3)'). As an
+ example, the following plots the geometric series up to \(O (z^{11))\)
+ on a disk of radius \(1.2\) around \(0\) with a resolution of 400 by
+ 400 pixels.
+ ,----
+ | cat >coeffs.txt <<EOF
+ | 1 1 1 1 1 1 1 1 1 1 1
+ | EOF
+ |
+ | polyplot -R400 -r1.2 coeffs.txt
+ `----
+
+
+License
+=======
+
+ This project is released under the GPL version 3.0 or later (see the
+ file `COPYING').
--
GitLab