From 7f46246b2bdc8bfe177ced452263dbd077a547a6 Mon Sep 17 00:00:00 2001
From: J08nY
Date: Sun, 4 Jun 2017 20:08:17 +0200
Subject: Add docs about point options.

 - Adds some docs about the possible --points= options.
 - Adds cmake/ to .gitignore.
---
 docs/points.mkd | 33 +++++++++++++++++++++++++++++++++
 docs/readme.md  |  1 +
 2 files changed, 34 insertions(+)
 create mode 100644 docs/points.mkd

(limited to 'docs')

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)
-- 
cgit v1.2.3-70-g09d2