Added some docs, moved license

2 files changed, 149 insertions, 0 deletions

diff --git a/docs/output.md b/docs/output.md
new file mode 100644
index 0000000..26b30db
--- /dev/null
+++ b/docs/output.md
@@ -0,0 +1,146 @@
+# Output
+
+There are two output formats currently supported in ecgen, JSON and CSV. These are enabled by using the `-tjson / --format=json`, `-tcsv / --format=csv` options, respectively.
+
+## JSON
+
+Self-explanatory format. The curve dictionaries are enclosed in an array as you might generate more curves at once (`-c / --count`). The only interesting thing is that while generating invalid curves for a curve with the `-i / --invalid` option, the original curve is output first.
+
+#### Example - prime field
+
+	[
+	{
+	    "field": {
+	        "p": "0xfa4101a601c3088f"
+	    },
+	    "a": "0x223fcc1306c21406",
+	    "b": "0x4114b86128071651",
+	    "order": "0xfa4101a5b65111b6",
+	    "generators": [
+	        {
+	            "x": "0x41b71e83794c614a",
+	            "y": "0xc43c15e114f16ba1",
+	            "order": "0xfa4101a5b65111b6",
+	            "cofactor": "0x1"
+	        }
+	    ],
+	    "points": [
+	        {
+	            "x": "0x7427f55c615d0c60",
+	            "y": "0x0000000000000000",
+	            "order": "0x2"
+	        },
+	        {
+	            "x": "0x357cbff05dacc66c",
+	            "y": "0x4f5d5e523a38a35a",
+	            "order": "0xd"
+	        },
+	        {
+	            "x": "0x4ef832dbb406dac6",
+	            "y": "0x684eb7a227fc23c3",
+	            "order": "0x8b60007"
+	        },
+	        {
+	            "x": "0xd82bdb55db6bb3ef",
+	            "y": "0xc103b77986a1c2e3",
+	            "order": "0x11ade0181"
+	        }
+	    ]
+	}]
+
+#### Example - binary field
+
+	[
+	{
+	    "field": {
+	        "m": "0x40",
+	        "e1": "0x4",
+	        "e2": "0x3",
+	        "e3": "0x1"
+	    },
+	    "a": "0x3869c3f4bbeb4087",
+	    "b": "0xba60557c283d94cd",
+	    "order": "0xffffffffea115f5a",
+	    "generators": [
+	        {
+	            "x": "0x4dcc3b35abcc13e4",
+	            "y": "0x4380aa919232c5b1",
+	            "order": "0xffffffffea115f5a",
+	            "cofactor": "0x1"
+	        }
+	    ],
+	    "points": [
+	        {
+	            "x": "0x0000000000000000",
+	            "y": "0x0000000000000000",
+	            "order": "0x2"
+	        },
+	        {
+	            "x": "0xde23b127982c9db7",
+	            "y": "0x1c63aa4b52327ca0",
+	            "order": "0x13"
+	        },
+	        {
+	            "x": "0xcb00f2cf13a8bab9",
+	            "y": "0x192a159ad11df21b",
+	            "order": "0xf1"
+	        },
+	        {
+	            "x": "0x3b9cd618b48e9a73",
+	            "y": "0xdacc98d7c32d8c0b",
+	            "order": "0x649"
+	        },
+	        {
+	            "x": "0xdbdf22552a10abbe",
+	            "y": "0x0dd6e81435a11566",
+	            "order": "0x2f94b"
+	        },
+	        {
+	            "x": "0x963ae5e637a9917a",
+	            "y": "0x1974294368f7f6d1",
+	            "order": "0x6203c5"
+	        }
+	    ]
+	}]
+
+
+## CSV
+
+This format is useful mostly for input and is not uniquely parseable for most curves, thus is deprecated. It is uniquely parseable for the set of common cryptographic domain parameters.
+
+#### Notation
+
+ - `p` - prime F_p
+ - `m` - binary field exponent F_2^m
+ - `e1` - largest exponent of the field polynomial
+ - `e2` - middle exponenet of the field polynomial, or `0000` if field poly is a trinomial
+ - `e3` - smallest exponent (except zero) of the field polynomial, or `0000` if field poly is a trinomial
+ - `a` - a parameter in short Weierstrass curve equation
+ - `b` - b parameter in short Weierstrass curve equation
+ - `gx` - x coordinate of the curve base-point g
+ - `gy` - y coordinate of the curve base-point g
+ - `n` - the base-point order
+ - `h` - the base-point cofactor
+ - `px` - the x coordinate of the point
+ - `py` - the y coordinate of the point
+ - `op` - the order of the point
+
+#### Prime field
+
+    p, a, b, gx, gy, n, h
+
+More generaly:
+
+    p, a, b, gx, gy(, gx2, gy2)?, n, (px, py, op)*, h
+    
+#### Binary field
+
+    m, e1, e2, e3, a, b, gx, gy, n, h
+    
+More generaly:
+
+    m, e1, e2, e3, a, b, gx, gy(, gx2, gy2)?, n, (px, py, op)*, h
+
+#### Example:
+
+    0x9bbd697be66af329,0x49ec7aa186e501f7,0x88e93b218fff3b55,0x9bbd697c54a8e780,0x206c5696b67702bb,0x328f7cb39358ae23,0x26ef5a5f152a39e0,0x4,0x1af56d479450c41b,0x01902f3d0c1ae199,0x9bbd697c54a8e78,0x10,0x21fdf0cd456005f6,0x0000000000000000,0x2,0x682f77abb827b2fa,0x8b7adcd4b4bbdb7f,0x685,0x94bc802fc965c386,0x212c07693dbabc19,0x2fc6c2a43943
\ No newline at end of file
diff --git a/docs/readme.md b/docs/readme.md
new file mode 100644
index 0000000..6c58854
--- /dev/null
+++ b/docs/readme.md
@@ -0,0 +1,3 @@
+# ecgen docs
+
+ - [Output](output.md)