aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJ08nY2017-02-07 04:06:09 +0100
committerJ08nY2017-02-07 04:12:04 +0100
commit06d927c9737589ed76b516c54ee74c8e6e44702b (patch)
tree8e7560f66a96e5bf5bb391907c3678f65581631a /README.md
parent96bf13d11b595aabf514c706adcf57aefc660a1f (diff)
downloadecgen-06d927c9737589ed76b516c54ee74c8e6e44702b.tar.gz
ecgen-06d927c9737589ed76b516c54ee74c8e6e44702b.tar.zst
ecgen-06d927c9737589ed76b516c54ee74c8e6e44702b.zip
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 21 insertions, 13 deletions
diff --git a/README.md b/README.md
index e02298f..c4b82ae 100644
--- a/README.md
+++ b/README.md
@@ -6,24 +6,30 @@ Tool for generating Elliptic curve domain parameters.
#### ecgen
The main binary of the tool, does the hard work.
-```
-ecgen --fp/--f2m -r BITS
-```
- - `--fp`/`--f2m` specifies the field type(prime/binary).
- - `-r` requests a random curve to be generated, currently only supported feature.
- - `-o/--output FILE` writes output to `FILE`.
- - `-i/--input FILE` reads input from `FILE`.
- - `-a/--append` appends to output file(doesn't overwrite it).
- - `-d/--datadir DIR` specifies the PARI/GP datadir containing the `seadata` package.
+
+`
+ecgen --fp/--f2m -r -p BITS
+`
+
+ - `--fp`/`--f2m` specifies the field type (prime/binary).
+ - `-r/--random` requests a random curve to be generated.
+ - `-p/--prime` requests the curve order to be prime.
+ - `-s/--seed=[SEED]` requests to generate a curve based on the ANSI X9.62 generation process and seed `SEED`.
+ - `-o/--output=FILE` writes output to `FILE`.
+ - `-f/--input=FILE` reads input from `FILE`.
+ - `-a/--append` appends to output file (doesn't overwrite it).
+ - `-d/--datadir=DIR` specifies the PARI/GP datadir containing the `seadata` package.
### Build
-```
+
+`
git clone https://github.com/J08nY/ecgen.git
cd ecgen
make
-```
+`
### Requirements
+
- PARI/GP
- parson
@@ -34,7 +40,8 @@ additional [seadata](http://pari.math.u-bordeaux.fr/packages.html) package (sead
[parson](https://github.com/kgabis/parson) is used to output curve parameters in JSON format.
### License
-```
+
+`
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
@@ -47,5 +54,6 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-```
+`
+
*© Eastern Seaboard Phishing Authority*