Neko Starter's Guide
So you want to learn about Neko? Here is a step-by-step guide to making and running your first Neko program. Before you start, please choose a distribution, download it, and get ready to install it. But first, you should know that the pronunciation of "Neko" is
Decompress the archive and put it into the folder you want :
- on Windows, you can use
- on Mac, Linux, and other Unix systems, use a temp folder and we will move the files to appropriate locations in the next step
The archive contains :
neko: the virtual machine boot binary
neko.dll + neko.libon Windows) : the NekoVM library
nekoc: the command-line Neko compiler
nekoml: the command-line NekoML compiler
nekoml.std: the NekoML standard library
nekotools: neko utilities (including dev web server)
.ndllfiles : the Neko standard libraries
gc.dll(on Windows only) : the garbage collector used by Neko
include/: this directory contains the .H files needed for embedding and extending the VM
CHANGES: some text documents
You have to setup a few things :
On Mac, Linux, and other Unix systems : Put
/usr/local/lib/neko. Put the
/usr/local/include. On Linux, you may have to run
sudo ldconfig /usr/local/libto refresh the library cache.
Once this is done you should be able to run the
neko command from any directory. Please check that
neko is working. (On Windows you can you can open a command terminal using
Start / Run.. and entering
cmd then OK).
You should now be able to run the test : execute
neko -version and it should print something like
2.2.0. Now you can start using Neko.
Compiling from Sources
Compiling Neko directly from sources is a little more difficult. See README.md for additional instructions.
You can now start creating your first program
$print("hello neko world !\n");
hello.neko file into a
hello.n file using the Neko command-line compiler by calling
nekoc hello.neko. If you didn't make any syntax errors, this will produce a
hello.n file containing the compiled bytecode of your sources.
You can now run this bytecode "module" by calling
neko hello. This should print the usual funny string to the standard output.
From here on, you're no longer a beginner so you can start reading the other documents.