____ ____ ____ ____ 
||n |||i |||m |||f ||


the nimf guide : download and build


The source code for nimf is hosted in a git repository. If you have git installed, you can run the following command from your terminal (on a unix-like system):

git clone https://git.rawtext.club/sloum/nimf && cd nimf

If you do not have git installed on your system and still want access to the source code you can alternately download a zip file of the code:


Now that you have the code on your system you will need to build the nimf interpreter.


To build nimf you will need a Go compiler. If you do not have one, you may be able to get one from your operating system's package repository. Or, if you prefer, you can download one directly from the Go website:

Most any semi-recent version should work fine. Though I would recommend >= 1.11.

In addition to Go it is helpful to have Make installed on your system. Most unix/bsd/linux systems should already have a version of Make installed. If not, check with your system's package repository. It is possible to build nimf without Make, but is beyond the scope of the instructions presented here.

Using the Makefile

A few Make targets have been set up for your convenience.

If you have administrator privleges (or your system does not require them for a global install), you can run the following from within the main nimf source code directory you cloned/downloaded:

sudo make install

It is possible your system will not require sudo, or may use an alternative such as doas.

The above command will install the interpreter, the manpage, and the standard library.

If you find yourself just wanting to update the library for an existing install, you can run:

sudo make install-lib

If you prefer, or need, to install locally for just your user you can run:

make install-local

That will build nimf in the current directory and install the standard library to a location inside your user directory (either $XDG_DATA_HOME or ~/.local/share/nimf). No man page is installed, but the one in the source code directory can be moved wherever is convenient for you. Using this local setup you may need to move nimf onto your path via your prefered means of doing so. Once the standard library is installed locally it will be found automatically when you run nimf and will override any system version of the library.