aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/points.mkd33
-rw-r--r--docs/readme.md1
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/points.mkd b/docs/points.mkd
new file mode 100644
index 0000000..f931bb4
--- /dev/null
+++ b/docs/points.mkd
@@ -0,0 +1,33 @@
+# Points
+
+## all
+```
+--points=all
+```
+
+Generates points on all subgroups of a curve. One point on each subgroup. This includes prime order subgroups.
+
+## prime
+```
+--points=prime
+```
+
+Generates points on prime order subgroups of a curve.
+
+## nonprime
+```
+--points=nonprime
+```
+
+Generates points on all composite order subgroups of a curve.
+
+## random
+```
+--points=[num]random
+```
+
+Generates `num` random points.
+
+## none
+
+Generates no points whatsoever. \ No newline at end of file
diff --git a/docs/readme.md b/docs/readme.md
index 6c58854..2fc5335 100644
--- a/docs/readme.md
+++ b/docs/readme.md
@@ -1,3 +1,4 @@
# ecgen docs
- [Output](output.md)
+ - [Points](points.md)