summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore19
-rw-r--r--README.md2
-rw-r--r--docs/points.mkd33
-rw-r--r--docs/readme.md1
4 files changed, 36 insertions, 19 deletions
diff --git a/.gitignore b/.gitignore
index d0c8bac..38a8e03 100644
--- a/.gitignore
+++ b/.gitignore
@@ -66,27 +66,10 @@ dkms.conf
# User-specific stuff:
.idea/
-.idea/workspace.xml
-.idea/tasks.xml
-
-# Sensitive or high-churn files:
-.idea/dataSources/
-.idea/dataSources.ids
-.idea/dataSources.xml
-.idea/dataSources.local.xml
-.idea/sqlDataSources.xml
-.idea/dynamic.xml
-.idea/uiDesigner.xml
-
-# Gradle:
-.idea/gradle.xml
-.idea/libraries
-
-# Mongo Explorer plugin:
-.idea/mongoSettings.xml
## CMake
build/
+cmake/
## File-based project format:
*.iws
diff --git a/README.md b/README.md
index b57d5c7..03b3e5f 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@ Tool for generating Elliptic curve domain parameters.
- `-K / --koblitz` Generate a Koblitz curve (a = 0).
- `-n / --order=ORDER` Generate a curve with given `ORDER` (using Complex Multiplication). **TODO - NOT IMPLEMENTED**
- `-p / --prime` Generate a curve with prime order.
- - `--points=TYPE` Generate points of given `TYPE` (random/prime/all/none).
+ - `--points=TYPE` Generate points of given `TYPE` (random/prime/all/nonprime/none).
- `-r / --random` Generate a random curve (using Random approach).
- `-s / --seed[=SEED]` Generate a curve from `SEED` (ANSI X9.62 verifiable procedure). **TODO - NOT IMPLEMENTED**
- `-u / --unique` Generate a curve with only one generator.
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)