aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 1065ea69f8bf0e26491bd93acc67c34f2259f9dd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# 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
$ ./configure
$ make
$ doas make install
```

by default it will compile also `nimisewi.cgi` and `nimisewi_gemini.cgi` and
if you wish, you can throw them into your cgi-bin folder and serve them using
whatever cgi thing you want. also they are statically linked, so you don't
need to worry if your web server is chrooted.

see examples here:

- [http](https://aaoth.xyz/nimisewi)
- [gemini](gemini://aaoth.xyz/cgi-bin/nimisewi)

## usage

```terminal
$ nimisewi

poka sutopatikuna pi open sama
```

## adding new words

to add new words, edit `nimitoki.txt` file. add one word per line.

then, just clean everything and recompile the program.

```terminal
$ vim nimitoki.txt
$ make distclean
$ ./configure
$ 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

all code that makes up `nimisewi`, `nimisewi.cgi`, `nimisewi_gemini.cgi` and
`makenimitoki` programs is licensed under ISC license
(see [LICENSE](/file?name=LICENSE&ci=tip)).

`nimitoki.txt` is in public domain.

GNU Autotools (in autotools directory) are licensed under GPLv3 license
(see [autotools/LICENSE.txt](/file?name=autotools/LICENSE.txt&ci=tip)).