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, 51 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b3cc309
--- /dev/null
+++ b/README.md
@@ -0,0 +1,51 @@
+# nimisewi
+
+nimisewi is a small program that outputs random toki pona phrase.
+[toki pona](https://tokipona.org) is a small conlang created by sonja lang.
+
+[first implementation](https://fsl.aaoth.xyz/nimisewi.py)
+was created using python, but then i decided to create more portable version.
+
+## installation
+
+installation is very straightforward:
+
+```terminal
+$ fsl clone https://fsl.aaoth.xyz/nimisewi.c
+$ cd nimisewi
+$ make
+$ doas make install
+```
+
+## usage
+
+```
+$ nimisewi
+
+nanpa apeja pi sin len
+```
+
+## adding new words
+
+to add new words, edit `nimitoki.txt` file. add one word per line.
+
+then, rebuild `nimitoki.c` and `nimitoki.h` and then relink the whole program.
+
+```terminal
+$ vim nimitoki.txt
+$ make distclean
+$ make
+  ...
+```
+
+## bugs
+
+i am pretty much beginner in c, so it is possible that the code contains some
+odd things.
+
+if you have found something wrong or weird,
+send me an email to `aaoth_at_aaoth_dot_xyz`.
+
+## license
+
+isc. see [LICENSE](/LICENSE).