added license information to main code files.v0.0.2

added comments to the code.

added readme (very similar to the fossil wiki page, just for completeness).

FossilOrigin-Name: 7d5413782349944209dea2a447563c5e3ac817ebdb01822d3f87a33423a1f5d8

1 files changed, 19 insertions, 3 deletions

diff --git a/nimisewi.h b/nimisewi.h
index cf64fb4..f816ea9 100644
--- a/nimisewi.h
+++ b/nimisewi.h
@@ -1,10 +1,26 @@
+/* Copyright (c) 2021, la-ninpre
+ * 
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
 #ifndef NIMI_SEWI_H
 #define NIMI_SEWI_H
 
+/* struct to hold stuff useful for random index generation */
 struct nanpa_nimi {
-    int nanpa_nimi;
-    int pi_li_lon;
-    int nanpa_pi;
+    int nanpa_nimi; /* number of words */
+    int pi_li_lon;  /* whether to insert 'pi' or not */
+    int nanpa_pi;   /* index to insert 'pi', if pi_li_lon is 1 */
 };
 
 void open_e_nanpa_sewi(void);