diff options
| author | la-ninpre <leobrekalini@gmail.com> | 2021-09-01 23:31:06 +0000 |
|---|---|---|
| committer | la-ninpre <leobrekalini@gmail.com> | 2021-09-01 23:31:06 +0000 |
| commit | 961ebbeaf7100a60522b0048f43d33f8771c4dbb (patch) | |
| tree | 93f85a7a4587d4bf10696980350f3be776f68aa9 | |
| parent | 9751403aeb161a49287582fab5965d33801bd76c (diff) | |
| download | nimisewi_c-961ebbeaf7100a60522b0048f43d33f8771c4dbb.tar.gz nimisewi_c-961ebbeaf7100a60522b0048f43d33f8771c4dbb.zip | |
updated readme
FossilOrigin-Name: aa798387d14b3056ce23fc479bafc89a1704a0bf57c009f3e1ecd0ca3009d2a9
| -rw-r--r-- | README.md | 42 |
1 files changed, 22 insertions, 20 deletions
@@ -7,6 +7,7 @@ nimisewi is a small program that outputs random toki pona phrase. was created using python, but then i decided to create more portable version. ## dependencies + - cmake (>=3.10) ## installation @@ -24,21 +25,21 @@ $ doas make install ### compilation options -- BUILD_CGI -- compile `nimisewi.cgi`, a cgi version +- **BUILD_CGI** -- compile `nimisewi.cgi`, a cgi version of nimisewi (default OFF). - [see example](https://aaoth.xyz/nimisewi). + [see example](https://aaoth.xyz/nimisewi). -- CGI_INSTALL_DIR -- installation directory for `nimisewi.cgi` - (default -- "$PREFIX/var/www/htdocs/cgi-bin"). +- **CGI_INSTALL_DIR** -- installation directory for `nimisewi.cgi` + (default "$PREFIX/var/www/htdocs/cgi-bin"). -- BUILD_GEMINI_CGI -- compile `nimisewi_gemini.cgi`, a cgi script - for gemini protocol. +- **BUILD_GEMINI_CGI** -- compile `nimisewi_gemini.cgi`, a cgi script + for gemini protocol (default OFF). - [see example](gemini://aaoth.xyz/cgi-bin/nimisewi) + [see example](gemini://aaoth.xyz/cgi-bin/nimisewi). -- GEMINI_CGI_INSTALL_DIR -- installation directory for `nimisewi_gemini.cgi` - (default -- "$PREFIX/var/gemini/cgi-bin") +- **GEMINI_CGI_INSTALL_DIR** -- installation directory for `nimisewi_gemini.cgi` + (default "$PREFIX/var/gemini/cgi-bin"). to specify these options, pass them as `-D{OPTION}` to initial cmake invocation. for example, these commands result in building both http and gemini @@ -55,7 +56,7 @@ $ cmake --build . ```terminal $ nimisewi -poka sutopatikuna pi open sama +musi taso jaki pi selo olin lukin ``` ## adding new words @@ -67,22 +68,23 @@ then, just clean everything and recompile the program. ```terminal $ vim nimitoki.txt $ cd build +$ make clean $ make ... ``` ## changelog -- 0.0.1 -- initial release -- 0.0.2 -- added license and comments to the code -- 0.0.3 -- added cgi for http and gemini, separated main code from nimisewi core -- 0.0.3.1 -- fixed errors in http header -- 0.0.4 -- added title and favicon to http cgi -- 0.0.4.1 -- fixed errors in http cgi -- 0.0.4.2 -- added missing error check to main -- 0.1.0 -- added words from lipu ku, added gnu autotools build system -- 0.1.1 -- added 'ku' word itself -- 0.2.0 -- switched to cmake build system, added '-v' and '--version' flags to +- **0.0.1** -- initial release +- **0.0.2** -- added license and comments to the code +- **0.0.3** -- added cgi for http and gemini, separated main code from nimisewi core +- **0.0.3.1** -- fixed errors in http header +- **0.0.4** -- added title and favicon to http cgi +- **0.0.4.1** -- fixed errors in http cgi +- **0.0.4.2** -- added missing error check to main +- **0.1.0** -- added words from lipu ku, added gnu autotools build system +- **0.1.1** -- added 'ku' word itself +- **0.2.0** -- switched to cmake build system, added '-v' and '--version' flags to nimisewi, that are outputting version information and compile features ## bugs |